{ "openapi": "3.1.0", "info": { "title": "Sigma Computing Public REST API", "version": "2.0.0", "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" } }, "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" }, "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": {} } ] } } }, "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 - 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" ], "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)." } } }, "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\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" ], "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)." } } } } } }, "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" ] } }, "/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": [ { "type": "object", "required": [ "grant_type" ], "properties": { "grant_type": { "type": "string", "enum": [ "client_credentials" ], "description": "Set to `client_credentials` to retrieve an access token." } }, "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" }, { "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" ] } }, "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": [ { "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." } }, "description": "", "title": "Access / Refresh token" }, { "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." } }, "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" }, "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": [ { "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": "Configure write-back for non-OAuth connections" }, "writebackSchemas": { "type": "array", "items": { "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": "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 meaningful for Snowflake OAuth connections." } } } ] }, "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" ] }, "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" } } } } } }, { "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" } } } ], "description": "", "title": "Set write location and materialization warehouse" }, { "type": "object", "properties": { "materializationWarehouse": { "type": "string", "description": "Warehouse to use 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 writebackSchema" } } } ] }, "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" }, "roleSwitching": { "type": "string", "enum": [ "allRoles", "disabled" ], "description": "Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful 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" } } } ] }, { "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 writebackSchema" } } } ] }, "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." } } } ], "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" } ] }, "name": { "type": "string" } } }, { "type": "object", "properties": { "description": { "type": "object", "additionalProperties": {} }, "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" }, "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": [ { "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": "Configure write-back for non-OAuth connections" }, "writebackSchemas": { "type": "array", "items": { "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": "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 meaningful for Snowflake OAuth connections." } } } ] } } } }, "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" }, "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": [ { "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": "Configure write-back for non-OAuth connections" }, "writebackSchemas": { "type": "array", "items": { "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": "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 meaningful for Snowflake OAuth connections." } } } ] } } } }, "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" }, "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": [ { "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": "Configure write-back for non-OAuth connections" }, "writebackSchemas": { "type": "array", "items": { "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": "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 meaningful for Snowflake OAuth connections." } } } ] } } } }, "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" } } } } } }, { "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" } } } ], "description": "", "title": "Set write location and materialization warehouse" }, { "type": "object", "properties": { "materializationWarehouse": { "type": "string", "description": "Warehouse to use 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 writebackSchema" } } } ] }, "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" }, "roleSwitching": { "type": "string", "enum": [ "allRoles", "disabled" ], "description": "Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful 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" } } } ] }, { "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 writebackSchema" } } } ] }, "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." } } } ], "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" } ] }, "name": { "type": "string" } } }, { "type": "object", "properties": { "description": { "type": "object", "additionalProperties": {} }, "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" }, "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": [ { "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": "Configure write-back for non-OAuth connections" }, "writebackSchemas": { "type": "array", "items": { "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": "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 meaningful for Snowflake OAuth connections." } } } ] } } } }, "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" ] } }, "/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}/materialization-schedules](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}/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" ] } } }, { "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" ] } } }, { "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" ] } } }, { "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 details" }, { "allOf": [ { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "table", "dataset", "data-model", "element", "customSQL", "csv-upload" ] } } }, { "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" ] } } }, { "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" } ] } }, "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/materializations](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": "materializationId" }, "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", "elementName", "schedule", "configuredAt", "paused" ], "properties": { "sheetId": { "type": "string", "description": "Identifier of the materialization schedule for the element", "title": "Sheet 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": { "$ref": "openapi-spec-code-representation-production.json#/components/schemas/DataModelSpec" } } } }, "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- 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": { "$ref": "openapi-spec-code-representation-production.json#/components/schemas/UpdateDataModelSpec" } } } }, "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": { "$ref": "openapi-spec-code-representation-production.json#/components/schemas/CreateDataModelSpec" } } } }, "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. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. 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 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.\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" } ], "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. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. 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. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. 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. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. 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. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. 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. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. 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. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. 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 to a data model. The response always includes the dataset's link and reference counts. Pass `dryRun: true` to skip the migration and return only the counts.\n\n**Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer.", "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 number of links and references the dataset has. Defaults to false.", "title": "Dry run" } } } ] } } } }, "responses": { "200": { "description": "The response body.", "content": { "application/json": { "schema": { "type": "object", "required": [ "dataModelId", "linkCount", "referenceCount" ], "properties": { "dataModelId": { "type": [ "string", "null" ], "description": "ID of the newly-created data model. Null when `dryRun` is true.", "title": "Data model ID" }, "linkCount": { "type": "number", "description": "Number of link edges the dataset has to other datasets.", "title": "Link count" }, "referenceCount": { "type": "number", "description": "Number of reference edges 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. Starting June 2, 2026, you will no longer be able to create datasets or edit existing datasets. 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 (Beta)", "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**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 **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." } } } ] } } } }, "responses": { "200": { "description": "The response body.", "content": { "application/json": { "schema": { "type": "object", "required": [ "deploymentPolicyId" ], "properties": { "deploymentPolicyId": { "type": "string" } } } } } }, "default": { "$ref": "#/components/responses/ApiError" } }, "externalDocs": { "url": "", "description": "Sigma API documentation:" }, "tags": [ "deploymentPolicies" ] }, "get": { "summary": "List deployment policies (Beta)", "description": "List all deployment policies set up for an 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 ", "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 (Beta)", "description": "Get details for a deployment policy.\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 `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 (Beta)", "description": "Update a deployment policy. Only the fields included in the request are changed.\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 `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 (Beta)", "description": "Archive a deployment policy.\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 `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 (Beta)", "description": "List documents for a deployment policy\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 `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\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": "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 (Beta)", "description": "Add documents to a deployment policy.\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 `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\n### Usage scenarios\n- Centrally manage documents that are deployed to specific tenant organizations.\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 document." } } } } } }, "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 (Beta)", "description": "Remove a document from a deployment policy.\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 `deploymentPolicyId` from the [/v2/deploymentPolicies](https://help.sigmacomputing.com/reference/list-deployments) endpoint.\n- To remove workbooks from a deployment policy, retrieve the relevant `workbookId` from the [/v2/workbooks](https://help.sigmacomputing.com/reference/list-workbooks) endpoint.\n- To remove data models from a deployment policy, retrieve the relevant `dataModelId` from the [/v2/datamodels](https://help.sigmacomputing.com/reference/list-data-models) endpoint.\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 (Beta)", "description": "Add a tenant to a deployment policy.\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 `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." } } } } } }, "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 (Beta)", "description": "List tenants for a deployment policy.\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 `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 (Beta)", "description": "Remove a tenant from a deployment policy.\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 `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 (Beta)", "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**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 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": { "oneOf": [ { "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": { "oneOf": [ { "type": "string", "enum": [ "create" ] }, { "type": "string", "enum": [ "annotate" ] }, { "type": "string", "enum": [ "organize" ] }, { "type": "string", "enum": [ "explore" ] }, { "oneOf": [ { "type": "string", "enum": [ "view" ] }, { "type": "string", "enum": [ "edit" ] }, { "type": "string", "enum": [ "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", "required": [ "code", "message", "requestId" ], "properties": { "code": { "type": "number" }, "message": { "type": "string" }, "requestId": { "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." } } } ] }, "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": "", "createdBy": "", "updatedBy": "", "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": { "oneOf": [ { "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": { "oneOf": [ { "type": "string", "enum": [ "create" ] }, { "type": "string", "enum": [ "annotate" ] }, { "type": "string", "enum": [ "organize" ] }, { "type": "string", "enum": [ "explore" ] }, { "oneOf": [ { "type": "string", "enum": [ "view" ] }, { "type": "string", "enum": [ "edit" ] }, { "type": "string", "enum": [ "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", "required": [ "code", "message", "requestId" ], "properties": { "code": { "type": "number" }, "message": { "type": "string" }, "requestId": { "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." } } } ] }, "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": "", "createdBy": "", "updatedBy": "", "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": { "oneOf": [ { "type": "string", "enum": [ "create" ] }, { "type": "string", "enum": [ "annotate" ] }, { "type": "string", "enum": [ "organize" ] }, { "type": "string", "enum": [ "explore" ] }, { "oneOf": [ { "type": "string", "enum": [ "view" ] }, { "type": "string", "enum": [ "edit" ] }, { "type": "string", "enum": [ "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": "", "createdBy": "", "updatedBy": "", "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": { "oneOf": [ { "type": "string", "enum": [ "create" ] }, { "type": "string", "enum": [ "annotate" ] }, { "type": "string", "enum": [ "organize" ] }, { "type": "string", "enum": [ "explore" ] }, { "oneOf": [ { "type": "string", "enum": [ "view" ] }, { "type": "string", "enum": [ "edit" ] }, { "type": "string", "enum": [ "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": "", "createdBy": "", "updatedBy": "", "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": { "oneOf": [ { "type": "string", "enum": [ "create" ] }, { "type": "string", "enum": [ "annotate" ] }, { "type": "string", "enum": [ "organize" ] }, { "type": "string", "enum": [ "explore" ] }, { "oneOf": [ { "type": "string", "enum": [ "view" ] }, { "type": "string", "enum": [ "edit" ] }, { "type": "string", "enum": [ "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" ] } } } ] }, "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" ] } } } ] } } } }, "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" ] } } } ] } } } }, "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" ] } } } ] } } } }, "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 - **[Deprecated]** Using the `search` parameter is deprecated. If using `search` to filter by email address, you must URL encode the \"@\" character as `%40`.\n - Using `email` and `search` together is not supported.\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": "search", "schema": { "type": "string", "description": "**[Deprecated]** Use the `email` query parameter instead." }, "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": { "oneOf": [ { "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": { "oneOf": [ { "type": "string", "enum": [ "create" ] }, { "type": "string", "enum": [ "annotate" ] }, { "type": "string", "enum": [ "organize" ] }, { "type": "string", "enum": [ "explore" ] }, { "oneOf": [ { "type": "string", "enum": [ "view" ] }, { "type": "string", "enum": [ "edit" ] }, { "type": "string", "enum": [ "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", "required": [ "code", "message", "requestId" ], "properties": { "code": { "type": "number" }, "message": { "type": "string" }, "requestId": { "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." } } } ] }, "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": "", "createdBy": "", "updatedBy": "", "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": { "oneOf": [ { "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": { "oneOf": [ { "type": "string", "enum": [ "create" ] }, { "type": "string", "enum": [ "annotate" ] }, { "type": "string", "enum": [ "organize" ] }, { "type": "string", "enum": [ "explore" ] }, { "oneOf": [ { "type": "string", "enum": [ "view" ] }, { "type": "string", "enum": [ "edit" ] }, { "type": "string", "enum": [ "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", "required": [ "code", "message", "requestId" ], "properties": { "code": { "type": "number" }, "message": { "type": "string" }, "requestId": { "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." } } } ] }, "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": "", "createdBy": "", "updatedBy": "", "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": { "oneOf": [ { "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": { "oneOf": [ { "type": "string", "enum": [ "create" ] }, { "type": "string", "enum": [ "annotate" ] }, { "type": "string", "enum": [ "organize" ] }, { "type": "string", "enum": [ "explore" ] }, { "oneOf": [ { "type": "string", "enum": [ "view" ] }, { "type": "string", "enum": [ "edit" ] }, { "type": "string", "enum": [ "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" } } } ] }, { "type": "object", "required": [ "code", "message", "requestId" ], "properties": { "code": { "type": "number" }, "message": { "type": "string" }, "requestId": { "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." } } } ] }, "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": "", "createdBy": "", "updatedBy": "", "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": { "patch": { "summary": "Update organization settings", "description": "Update settings for the organization associated with the API credentials.\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 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": "updateOrganizationSettings", "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "type": "object", "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": { "allOf": [ { "type": "object", "required": [ "organizationId" ], "properties": { "organizationId": { "type": "string", "description": "Unique identifier of the organization" } } }, { "type": "object", "properties": { "timezone": { "type": "string", "description": "Current IANA timezone for the organization" } } } ] } } } }, "default": { "$ref": "#/components/responses/ApiError" } }, "externalDocs": { "url": "", "description": "Sigma API documentation:" }, "tags": [ "organizations" ] } }, "/v2/plugins": { "get": { "summary": "List custom plugins (Beta)", "description": "List custom plugins owned by the current organization.\n\n**Beta**: This documentation describes a private 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 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 custom plugin." }, "name": { "type": "string", "description": "Display name of the custom plugin." }, "description": { "type": [ "string", "null" ], "description": "Description of the custom 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 custom plugin (Beta)", "description": "Register a new custom 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**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 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 custom plugin." } } }, { "type": "object", "properties": { "description": { "type": [ "string", "null" ], "description": "Description of the custom 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 custom plugin." }, "name": { "type": "string", "description": "Display name of the custom plugin." }, "description": { "type": [ "string", "null" ], "description": "Description of the custom 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 custom plugin (Beta)", "description": "Get the metadata for a custom plugin by 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 **pluginId** by calling the [/v2/plugins](https://help.sigmacomputing.com/reference/list-custom-plugins) endpoint.", "parameters": [ { "name": "pluginId", "schema": { "type": "string", "description": "Unique identifier (UUID) of the custom 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 custom plugin." }, "name": { "type": "string", "description": "Display name of the custom plugin." }, "description": { "type": [ "string", "null" ], "description": "Description of the custom 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 custom plugin (Beta)", "description": "Update metadata fields on an existing custom plugin. Only fields included in the request are changed. The `url` field cannot be updated by this endpoint.\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 **pluginId** by calling the [/v2/plugins](https://help.sigmacomputing.com/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 custom 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 custom plugin." }, "description": { "type": [ "string", "null" ], "description": "Description of the custom 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 custom plugin." }, "name": { "type": "string", "description": "Display name of the custom plugin." }, "description": { "type": [ "string", "null" ], "description": "Description of the custom 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 custom plugin (Beta)", "description": "Permanently delete a custom plugin. Workbook elements that reference the deleted plugin remain in their workbooks but can no longer render plugin content.\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 **pluginId** by calling the [/v2/plugins](https://help.sigmacomputing.com/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 custom 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": { "application/json": { "schema": { "oneOf": [ { "type": "object", "required": [ "status", "download" ], "properties": { "status": { "type": "number", "enum": [ 200 ], "description": "Success", "title": "Success" }, "download": { "type": "object", "required": [ "stream", "contentType", "filename" ], "properties": { "stream": {}, "contentType": { "type": "string" }, "filename": { "type": "string" } }, "description": "Download results" } } }, { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "number", "enum": [ 204 ], "description": "Queued or running", "title": "Running" } } }, { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "number", "enum": [ 500 ], "description": "Internal server error", "title": "Error" }, "message": { "type": "string", "description": "Error message", "title": "Error" } } } ] }, "examples": { "Success": { "value": { "status": 200, "download": { "stream": "[Object NodeJS.ReadableStream]", "contentType": "application/octet-stream", "filename": "string" } } }, "Running": { "value": { "status": 204 } } } } } }, "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}/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": "The request body.", "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}/export": { "post": { "summary": "Export data from a report", "description": "This endpoint lets you create a file containing data exported from a report. Reports are exported as entire 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- Reports are exported as entire documents. You cannot export a specific page or element.\n- Only PDF exports are supported. Use the `layout` parameter to specify either `portrait` or `landscape` layout.\n- This endpoint is rate limited to 400 requests per minute.\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": [ { "type": "object", "required": [ "format" ], "properties": { "format": { "type": "object", "required": [ "type", "layout" ], "properties": { "type": { "type": "string", "enum": [ "pdf" ] }, "layout": { "type": "string", "enum": [ "portrait", "landscape" ] } } } } }, { "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": { "Export a report as PDF": { "value": { "format": { "type": "pdf", "layout": "portrait" } } }, "Export with parameters": { "value": { "format": { "type": "pdf", "layout": "landscape" }, "parameters": { "region": "North America" } } } } } } }, "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}/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/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 (Beta)", "description": "Create a shortcut that surfaces an existing item in another folder or workspace without duplicating it.\n\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 - 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 (Beta)", "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. Creating a **Deployment** source swap policy is in public beta. 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](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": [], "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" } ] } } } }, "responses": { "200": { "description": "The response body.", "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" ] }, "get": { "summary": "List source swap policies (Beta)", "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. Getting a list of **Deployment** source swap policies is in public beta. 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 (Beta)", "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. Updating a **Deployment** source swap policy is in public beta. 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": "The request body.", "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": "The response body.", "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 (Beta)", "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. Deleting a **Deployment** source swap policy is in public beta. 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 (Beta)", "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. Getting details for a **Deployment** source swap policy is in public beta. 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": "The response body.", "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 description of 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": "updateVersionTag", "requestBody": { "description": "The request body.", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the version 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" }, "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" } } } ] }, "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": [ "val", "type" ], "properties": { "val": { "type": "string", "description": "Value of the user attribute." }, "type": { "type": "string", "enum": [ "string" ], "description": "Type of 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}/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": [ "val", "type" ], "properties": { "val": { "type": "string", "description": "Value of the user attribute." }, "type": { "type": "string", "enum": [ "string" ], "description": "Type of 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 (Beta)", "description": "Create a new tenant organization with the specified name and organization slug to be used in the URL.\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- 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-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 (Beta)", "description": "Retrieve a paginated list of tenant organizations with optional filtering and sorting.\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- 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 (Beta)", "description": "Update the details of an existing tenant organization. The organization name and slug can be updated through this endpoint.\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 **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": "The request body.", "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 (Beta)", "description": "Delete a tenant organization by tenantOrganizationId.\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 **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 (Beta)", "description": "Retrieve details of a specific tenant organization by tenantOrganizationId.\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 **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 (Beta)", "description": "Retrieve a paginated list of tenant organizations that the specified tenant organization can deploy to.\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 **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" } } } ] } } } }, "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 (Beta)", "description": "Grant a tenant organization the capability to deploy to other tenant organizations.\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 **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": "The request body.", "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" } } } }, "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." } } } } } } } } }, "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 (Beta)", "description": "Revoke a tenant organization's capability to deploy to one or more tenant organizations.\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 **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": "The request body.", "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" } } } }, "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 (Beta)", "description": "Retrieve the workbook ID for a workbook deployed to a tenant organization for a given parent workbook and deployment policy.\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- 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": [ "val", "type" ], "properties": { "val": { "type": "string", "description": "Value of the user attribute." }, "type": { "type": "string", "enum": [ "string" ], "description": "Type of 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": [ "val", "type" ], "properties": { "val": { "type": "string", "description": "Value of the user attribute." }, "type": { "type": "string", "enum": [ "string" ], "description": "Type of user attribute." } }, "description": "Default value of the user attribute.", "title": "Default value" } } } ] } } } }, "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": [ "val", "type" ], "properties": { "val": { "type": "string", "description": "Value of the user attribute." }, "type": { "type": "string", "enum": [ "string" ], "description": "Type of user attribute." } }, "description": "Default value of the user attribute." } } } ] } } } }, "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": [ "val", "type" ], "properties": { "val": { "type": "string", "description": "Value of the user attribute." }, "type": { "type": "string", "enum": [ "string" ], "description": "Type of user attribute." } }, "description": "Default value of the user attribute." } } } ] } } } }, "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": [ "val", "type" ], "properties": { "val": { "type": "string", "description": "Value of the user attribute." }, "type": { "type": "string", "enum": [ "string" ], "description": "Type of 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": [ "val", "type" ], "properties": { "val": { "type": "string", "description": "Value of the user attribute." }, "type": { "type": "string", "enum": [ "string" ], "description": "Type of user attribute." } }, "description": "The value of the user attribute", "title": "Attribute value" } } } } } }, "examples": { "Request Example": { "value": { "assignments": [ { "teamId": "00000000-0000-0000-0000-000000000000", "value": { "val": "foo", "type": "string " } }, { "teamId": "00000000-0000-0000-0000-000000000001", "value": { "val": "bar", "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": [ "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": [ "val", "type" ], "properties": { "val": { "type": "string", "description": "Value of the user attribute." }, "type": { "type": "string", "enum": [ "string" ], "description": "Type of 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 (Beta)", "description": "Update a user attribute for one or more tenants. Currently, this endpoint only supports deleting a user attribute assignment.\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 **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 (Beta)", "description": "Assign and set the value of a specific user attribute for one or more tenants.\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 **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": [ "val", "type" ], "properties": { "val": { "type": "string", "description": "Value of the user attribute." }, "type": { "type": "string", "enum": [ "string" ], "description": "Type of user attribute." } }, "description": "The value of the user attribute", "title": "Attribute value" } } } } } }, "examples": { "Request Example": { "value": { "assignments": [ { "tenantOrganizationId": "00000000-0000-0000-0000-000000000000", "value": { "val": "foo", "type": "string" } }, { "tenantOrganizationId": "00000000-0000-0000-0000-000000000001", "value": { "val": "bar", "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": [ "user-attributes" ] } }, "/v2/user-attributes/{userAttributeId}/tenants/{tenantOrganizationId}": { "delete": { "summary": "Delete a user attribute for a tenant (Beta)", "description": "Delete a specific user attribute for a specific tenant.\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 **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 ", "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": "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": [ "val", "type" ], "properties": { "val": { "type": "string", "description": "Value of the user attribute." }, "type": { "type": "string", "enum": [ "string" ], "description": "Type of 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": [ "val", "type" ], "properties": { "val": { "type": "string", "description": "Value of the user attribute." }, "type": { "type": "string", "enum": [ "string" ], "description": "Type of user attribute." } }, "description": "The value of the user attribute", "title": "Attribute value" } } } } } }, "examples": { "Request Example": { "value": { "assignments": [ { "userId": "mTwJbaYKQbBexvF4ZWGeRxuAmbGKm", "value": { "val": "foo", "type": "string" } }, { "userId": "mTwJbaYKQbBexvF4ZWGeRxuAmbGKm", "value": { "val": "bar", "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": [ "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 configured webhook specification configured in Sigma.\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 webhook URL 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": "The request body.", "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/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/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" }, "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" } } } ] }, "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" }, "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" } } } ] }, "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 } ], "operationId": "getWorkbook", "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" }, "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" } } } ] }, "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}/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 bookmark to a workbook", "description": "Add a bookmark 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 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\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}/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": "The request body.", "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" }, "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" } } } ] } } } }, "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}/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\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" } ], "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": [ "secure", "public", "application" ], "description": "Defines the visibility and access control of the embed. Choose `public` for open access or `secure` for restricted access. The `secure` and `application` options are both deprecated.", "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" }, "filters": { "filter": "value" }, "rowLimit": "value", "offset": "value" } } } } } }, "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" ] } } }, { "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" ] } } }, { "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" ] } } }, { "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 details" }, { "allOf": [ { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "table", "dataset", "data-model", "element", "customSQL", "csv-upload" ] } } }, { "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" ] } } }, { "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" } ] } }, "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" } ], "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", "elementName", "schedule", "configuredAt", "paused" ], "properties": { "sheetId": { "type": "string", "description": "Identifier of the materialization schedule for the element", "title": "Sheet 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", "elementName", "schedule", "configuredAt", "paused" ], "properties": { "sheetId": { "type": "string", "description": "Identifier of the materialization schedule for the element", "title": "Sheet 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": "materializationId" }, "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}/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", "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 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": { "$ref": "openapi-spec-code-representation-production.json#/components/schemas/WorkbookSpec" } } } }, "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 `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- 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- 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": { "$ref": "openapi-spec-code-representation-production.json#/components/schemas/UpdateWorkbookSpec" } } } }, "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": "The request body.", "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" }, "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" } } } ] } } } }, "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 `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": { "$ref": "openapi-spec-code-representation-production.json#/components/schemas/CreateWorkbookSpec" } } } }, "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" ], "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." } } }, { "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", "required": [ "pages" ], "properties": { "pages": { "type": "array", "items": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "id", "type", "name", "elements" ], "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." }, "elements": { "type": "array", "items": { "oneOf": [ { "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": [ { "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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, { "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": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical alignment of cell content: start, middle, or end." }, "width": { "type": "number", "description": "Column width in pixels when overriding auto-sizing." }, "backgroundColor": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Cell background: `{ kind: theme, ref }` or hex `#rgb` / `#rrggbb` only." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Cell text color: `{ kind: theme, ref }` or hex only." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip' (no wrap)." } }, "description": "Grid presentation for this column (alignment, width, colors, wrap)." }, "link": { "oneOf": [ { "type": "object", "required": [ "kind", "columnId" ], "properties": { "kind": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "External id of a column in this table whose text values are the hyperlink URL." } } }, { "type": "object", "required": [ "kind", "formula" ], "properties": { "kind": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string", "description": "Text-typed formula for the hyperlink URL." } } } ], "description": "Hyperlink target for this column: another column’s text values or a custom URL formula." } } } ] }, "description": "The columns of the table and their formulas. Optional columns[].style holds grid presentation (enums, not booleans, for toggles)." }, "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } } } ], "description": "Table description (subtitle / tooltip text) plus optional styling." }, "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": "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." }, "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." } } } ] }, "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "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": "A Sling formula returning a boolean. The formula may reference any column on the sheet, not just the styled columns." } } } ] }, { "type": "object", "properties": { "style": { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Cell background color (hex)." }, "color": { "type": "string", "description": "Font color (hex)." }, "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 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": "Number or datetime format override for the displayed value." } } } } } ] }, { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "backgroundScale" ] } } }, { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "type": "string" }, "description": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "order": { "oneOf": [ { "type": "string", "enum": [ "descending" ] }, { "type": "string", "enum": [ "ascending" ] } ] }, "valueLabels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "string", "enum": [ "shown" ] } ] } } } ] } ] }, "description": "Conditional formatting applied to columns of this table. Order matters: later entries apply on top of earlier ones." }, "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Default sparkline mark formatting applied to all sparkline columns (Format tab apply-to-all)." }, "tableComponents": { "type": "object", "description": "Table component visibility toggles (summary bar, collapsed columns, etc.). Each key is `shown` or `hidden`; omit when shown (default)." }, "tableStyle": { "type": "object", "properties": { "preset": { "oneOf": [ { "type": "string", "enum": [ "spreadsheet" ] }, { "type": "string", "enum": [ "presentation" ] } ], "description": "Table preset: 'spreadsheet' or 'presentation'. Omit when spreadsheet (default)." }, "cellSpacing": { "oneOf": [ { "type": "string", "enum": [ "extra-small" ] }, { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Cell spacing preset: 'extra-small', 'small', 'medium', or 'large'." }, "gridLines": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "vertical" ] }, { "type": "string", "enum": [ "horizontal" ] }, { "type": "string", "enum": [ "all" ] } ], "description": "Grid lines: 'none', 'vertical', 'horizontal', or 'all'." }, "banding": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Row banding visibility: 'shown' or 'hidden'." }, "bandingColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "autofitColumns": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Autofit column widths (level table only): 'shown' or 'hidden'." }, "outerBorder": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Outer table border: 'shown' or 'hidden'. Maps to inverted store `hideOuterBorder`." }, "headerDividerColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "heavyVerticalDividers": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Heavier vertical group dividers (pivot only): 'shown' or 'hidden'." }, "heavyHorizontalDividers": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Heavier horizontal group dividers (pivot only): 'shown' or 'hidden'." }, "textStyles": { "type": "object", "properties": { "header": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "cell": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "columnHeader": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "rowHeader": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } } } } }, "description": "Table style: grid preset, spacing, grid lines, banding, autofit, dividers, and per-tab text styles." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "Actions triggered by interacting with this element." } } } ], "description": "", "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the KPI." }, "value": { "allOf": [ { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column id bound to the KPI value shelf." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide the KPI value number. Only applies when a comparison is configured. Omit when shown." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Value font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Value font size in pixels, or 'auto'." } } } ], "description": "KPI value shelf binding (`columnId`) plus optional Value-section styling." } } }, { "type": "object", "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Title font size in pixels, or 'auto' to let the viz pick." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size (numeric or `auto`), color, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`. KPI does not support alignment." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Description font size in pixels, or 'auto' to let the viz pick." } }, "description": "KPI description (subtitle / tooltip text) plus optional styling. KPI accepts `auto` font size." }, "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 chart." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "layout": { "type": "object", "properties": { "anchor": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Alignment: 'start', 'middle', or 'end'." }, "verticalAnchor": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical alignment: 'start', 'middle', or 'end'." }, "titleOrient": { "oneOf": [ { "type": "string", "enum": [ "top" ] }, { "type": "string", "enum": [ "bottom" ] } ], "description": "Title position: 'top' or 'bottom'." }, "comparisonValueOrient": { "oneOf": [ { "type": "string", "enum": [ "right" ] }, { "type": "string", "enum": [ "below" ] } ], "description": "Comparison value position: 'right' or 'below'." } }, "description": "KPI layout: alignment, title position, and comparison position." }, "comparison": { "type": "object", "properties": { "display": { "oneOf": [ { "type": "string", "enum": [ "percentage" ] }, { "type": "string", "enum": [ "delta" ] }, { "type": "string", "enum": [ "relative" ] }, { "type": "string", "enum": [ "absolute" ] } ], "description": "Comparison display: 'percentage', 'delta', 'relative', or 'absolute'." }, "direction": { "oneOf": [ { "type": "string", "enum": [ "higher" ] }, { "type": "string", "enum": [ "lower" ] }, { "type": "string", "enum": [ "none" ] } ], "description": "Comparison direction: 'higher', 'lower', or 'none'." }, "colorGood": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "colorNeutral": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "colorBad": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "arrow": { "type": "string", "enum": [ "hidden" ], "description": "Hide the comparison arrow. Omit when shown." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Comparison font size in pixels, or 'auto'." }, "label": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "string" } ], "description": "Comparison label text, or 'hidden' to hide the label." }, "labelColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "noDateText": { "type": "string", "description": "Label shown when the comparison date is invalid." } }, "description": "KPI comparison formatting (display, direction, colors, label)." }, "trend": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide the trend sparkline. Omit when shown." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "area" ] } ], "description": "Trend shape: 'line' or 'area'." }, "areaStyle": { "oneOf": [ { "type": "string", "enum": [ "gradient" ] }, { "type": "string", "enum": [ "solid" ] } ], "description": "Area fill style: 'gradient' or 'solid'. Only applies when shape is 'area'." }, "valueColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "comparisonColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "tooltip": { "type": "string", "enum": [ "shown" ], "description": "Explicitly enable a feature whose default is off." }, "xAxis": { "type": "string", "enum": [ "shown" ], "description": "Explicitly enable a feature whose default is off." }, "yAxis": { "type": "string", "enum": [ "shown" ], "description": "Explicitly enable a feature whose default is off." }, "noDataText": { "type": "string", "description": "Label shown when the trend has no data." } }, "description": "KPI trend sparkline formatting." }, "timeline": { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column id bound to the KPI timeline shelf (enables the trend sparkline)." } }, "description": "KPI timeline shelf binding (date column for the trend sparkline)." }, "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": "Period-over-period comparison grain (requires timeline). Mutually exclusive with comparisonColumn." }, "comparisonColumn": { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column id bound to the KPI comparison shelf (compare value to another measure)." } }, "description": "Comparison shelf binding (compare value to another measure). Mutually exclusive with periodComparison." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 data source for the bar 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the bar chart." }, "yAxis": { "allOf": [ { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "oneOf": [ { "type": "string", "description": "Column ID for a Y-axis series." }, { "allOf": [ { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column ID for a Y-axis series." } } }, { "type": "object", "properties": { "type": { "oneOf": [ { "type": "string", "enum": [ "bar" ] }, { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "scatter" ] } ], "description": "Per-series chart shape: 'bar' (default), 'line', 'area', or 'scatter'." } } } ] } ] }, "description": "Column IDs for the Y-axis series." } } }, { "type": "object", "properties": { "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "Y-axis title, labels, marks, and scale formatting." } } } ], "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order." }, "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "X-axis title, labels, marks, and scale formatting." } } } ], "description": "The column used for the X-axis." }, "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Chart description (subtitle / tooltip text) plus optional styling." }, "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": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend position. Default 'auto'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "colorLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the color legend when both color and size legends apply." }, "sizeLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the size legend when a size channel is present." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, position, and label styling." }, "tooltip": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." }, "multiSeries": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the tooltip lists multiple series. Only supported on bar, line, and area charts." }, "valueFormat": { "oneOf": [ { "type": "string", "enum": [ "percent" ] }, { "type": "string", "enum": [ "number" ] } ], "description": "Tooltip value format. Omit when the chart default applies." } }, "description": "Tooltip display options: column names, multiple series, and percent formatting." }, "stacking": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "stacked" ] }, { "type": "string", "enum": [ "normalized" ] } ], "description": "Stacking mode: 'none' (side-by-side / overlapping), 'stacked' (default — values sum), or 'normalized' (stack scaled to 100%)." }, "orientation": { "type": "string", "enum": [ "horizontal" ], "description": "Bar orientation. Omit (the default) for vertical bars; set to 'horizontal' for horizontal bars." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: single hex, categorical column, or continuous gradient." }, "barStyle": { "type": "object", "properties": { "cornerRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Bar corner shape: 'square' (default), 'round', or 'pill'." } }, "description": "Bar corner shape: 'square' (default), 'round', or 'pill'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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": "Number of decimal places when labels include percentages." }, "showStroke": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "on" ] }, { "type": "string", "enum": [ "off" ] } ], "description": "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": "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 values and labels to show on total (aggregate) labels." }, "orient": { "oneOf": [ { "type": "string", "enum": [ "horizontal" ] }, { "type": "string", "enum": [ "vertical" ] } ], "description": "Text direction for total labels." } }, "description": "Options for aggregate total labels on 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": "Gap width between individual bars in a band (format panel: Gap width)." }, "betweenSets": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Gap between bar clusters when the chart is clustered (format panel: Gap between sets)." } }, "description": "Bar gap width and spacing 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": "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 chart." }, "backgroundImage": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported)." } }, "description": "Optional plot-area background image. Url supports dynamic-text {{formula}} references." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "refMarks": { "type": "array", "items": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type", "axis", "value" ], "properties": { "type": { "type": "string", "enum": [ "line" ], "description": "Reference line." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Position on the axis (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Line stroke styling." } } }, { "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] }, { "allOf": [ { "type": "object", "required": [ "type", "axis", "value", "endValue" ], "properties": { "type": { "type": "string", "enum": [ "band" ], "description": "Reference band." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band start position (constant, column aggregation, or formula)." }, "endValue": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "constant" ] } } }, { "type": "object", "properties": { "value": { "type": "number", "description": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band end position (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Band outline visibility. Set to 'shown' to draw the band border." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Band outline stroke styling." }, "fill": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Band fill color (hex or theme reference)." } }, "description": "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] } ] }, "description": "Reference lines and bands on the chart." }, "trellis": { "type": "object", "properties": { "column": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis column facet." }, "row": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis row facet." }, "share": { "type": "object", "properties": { "color-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share color legends across the trellis grid. Omit when 'shared' (default)." }, "size-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share size legends across panels. Omit when 'shared'. Scatter with a size channel only." }, "x-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the category-axis scale across panels (UI label follows chart orientation)." }, "y-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the series-axis scale across panels (UI label follows chart orientation)." }, "y-axis-2": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the second series-axis scale. Combo charts with a second value axis only." } }, "description": "Shared scales and legends across trellis panels." }, "tileSize": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "compact" ] } ], "description": "Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series." } }, "description": "Trellis tile size, row/column facet styling, and shared scales/legends." }, "trendlines": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "columnId", "model" ], "properties": { "columnId": { "type": "string", "description": "Series column id (Y-axis) 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 matching the format panel: linear, quadratic, polynomial, exponential, logarithmic, or power." } } }, { "type": "object", "properties": { "degree": { "type": "number", "description": "Polynomial degree (3–7). Required when model is 'polynomial'." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Trend line stroke styling." }, "label": { "allOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } } }, { "type": "object", "properties": { "text": { "type": "string", "description": "Custom label text." } } } ], "description": "Custom label. Omit the block to hide the label." }, "value": { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } }, "description": "Regression fit value (R²). Omit the block to hide the value." }, "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 value annotation position." }, "fontSize": { "type": "number", "description": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and value annotations." } } } ] }, "description": "Regression trend lines on the chart." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the chart." }, "color": { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order." } } } ], "description": "The column for the categorical split (slice labels)." }, "value": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } }, "description": "The column for the slice size." } } }, { "type": "object", "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Chart description (subtitle / tooltip text) plus optional styling." }, "dataLabel": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex 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": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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": "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": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend position. Default 'auto'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "colorLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the color legend when both color and size legends apply." }, "sizeLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the size legend when a size channel is present." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, position, and label styling." }, "tooltip": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." }, "multiSeries": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the tooltip lists multiple series. Only supported on bar, line, and area charts." }, "valueFormat": { "oneOf": [ { "type": "string", "enum": [ "percent" ] }, { "type": "string", "enum": [ "number" ] } ], "description": "Tooltip value format. Omit when the chart default applies." } }, "description": "Tooltip display options: column names, multiple series, and percent formatting." }, "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 chart." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the chart." }, "color": { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order." } } } ], "description": "The column for the categorical split (slice labels)." }, "value": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } }, "description": "The column for the slice size." } } }, { "type": "object", "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Chart description (subtitle / tooltip text) plus optional styling." }, "dataLabel": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex 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": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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": "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": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend position. Default 'auto'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "colorLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the color legend when both color and size legends apply." }, "sizeLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the size legend when a size channel is present." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, position, and label styling." }, "tooltip": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." }, "multiSeries": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the tooltip lists multiple series. Only supported on bar, line, and area charts." }, "valueFormat": { "oneOf": [ { "type": "string", "enum": [ "percent" ] }, { "type": "string", "enum": [ "number" ] } ], "description": "Tooltip value format. Omit when the chart default applies." } }, "description": "Tooltip display options: column names, multiple series, and percent formatting." }, "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 chart." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "Actions triggered by interacting with this element." }, "holeValue": { "type": "object", "required": [ "id" ], "properties": { "id": { "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": "Hole value visibility. Omit when shown (default)." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Hole value font size in pixels." } } }, "title": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Hole title visibility. Omit when shown (default)." }, "text": { "type": "string", "description": "Hole title text." }, "wrap": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Text wrap: 'shown' to wrap, 'hidden' for single line." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Hole title font size in pixels." }, "position": { "oneOf": [ { "type": "string", "enum": [ "top" ] }, { "type": "string", "enum": [ "bottom" ] } ], "description": "Donut hole title position: 'top' or 'bottom'." } } } }, "description": "Donut hole center title and value styling." }, "innerRadius": { "type": "number", "description": "Donut hole size as a ratio of the outer radius (typically 0.4–0.8). Omit when default (0.6)." }, "trellis": { "type": "object", "properties": { "column": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis column facet." }, "row": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis row facet." }, "share": { "type": "object", "properties": { "color-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share color legends across the trellis grid. Omit when 'shared' (default)." }, "size-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share size legends across panels. Omit when 'shared'. Scatter with a size channel only." }, "x-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the category-axis scale across panels (UI label follows chart orientation)." }, "y-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the series-axis scale across panels (UI label follows chart orientation)." }, "y-axis-2": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the second series-axis scale. Combo charts with a second value axis only." } }, "description": "Shared scales and legends across trellis panels." }, "tileSize": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "compact" ] } ], "description": "Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series." } }, "description": "Trellis tile size, row/column facet styling, and shared scales/legends." } } } ] } ], "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the line chart." }, "yAxis": { "allOf": [ { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "oneOf": [ { "type": "string", "description": "Column ID for a Y-axis series." }, { "allOf": [ { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column ID for a Y-axis series." } } }, { "type": "object", "properties": { "type": { "oneOf": [ { "type": "string", "enum": [ "bar" ] }, { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "scatter" ] } ], "description": "Per-series chart shape: 'bar' (default), 'line', 'area', or 'scatter'." } } } ] } ] }, "description": "Column IDs for the Y-axis series." } } }, { "type": "object", "properties": { "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "Y-axis title, labels, marks, and scale formatting." } } } ], "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order." }, "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "X-axis title, labels, marks, and scale formatting." } } } ], "description": "The column used for the X-axis." }, "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Chart description (subtitle / tooltip text) plus optional styling." }, "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": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend position. Default 'auto'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "colorLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the color legend when both color and size legends apply." }, "sizeLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the size legend when a size channel is present." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, position, and label styling." }, "tooltip": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." }, "multiSeries": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the tooltip lists multiple series. Only supported on bar, line, and area charts." }, "valueFormat": { "oneOf": [ { "type": "string", "enum": [ "percent" ] }, { "type": "string", "enum": [ "number" ] } ], "description": "Tooltip value format. Omit when the chart default applies." } }, "description": "Tooltip display options: column names, multiple series, and percent formatting." }, "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 chart." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: 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." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Area outline visibility. Omit when shown; only 'hidden' is emitted on read. Not valid on line-chart." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 (on area charts) area outline visibility." }, "points": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Point markers. Omit when shown; only 'hidden' is emitted on read." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } }, "description": "Point markers on the series." } }, "description": "Line interpolation, stroke, point markers, and null handling for the series." }, "backgroundImage": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported)." } }, "description": "Optional plot-area background image. Url supports dynamic-text {{formula}} references." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "refMarks": { "type": "array", "items": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type", "axis", "value" ], "properties": { "type": { "type": "string", "enum": [ "line" ], "description": "Reference line." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Position on the axis (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Line stroke styling." } } }, { "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] }, { "allOf": [ { "type": "object", "required": [ "type", "axis", "value", "endValue" ], "properties": { "type": { "type": "string", "enum": [ "band" ], "description": "Reference band." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band start position (constant, column aggregation, or formula)." }, "endValue": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "constant" ] } } }, { "type": "object", "properties": { "value": { "type": "number", "description": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band end position (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Band outline visibility. Set to 'shown' to draw the band border." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Band outline stroke styling." }, "fill": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Band fill color (hex or theme reference)." } }, "description": "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] } ] }, "description": "Reference lines and bands on the chart." }, "trellis": { "type": "object", "properties": { "column": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis column facet." }, "row": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis row facet." }, "share": { "type": "object", "properties": { "color-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share color legends across the trellis grid. Omit when 'shared' (default)." }, "size-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share size legends across panels. Omit when 'shared'. Scatter with a size channel only." }, "x-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the category-axis scale across panels (UI label follows chart orientation)." }, "y-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the series-axis scale across panels (UI label follows chart orientation)." }, "y-axis-2": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the second series-axis scale. Combo charts with a second value axis only." } }, "description": "Shared scales and legends across trellis panels." }, "tileSize": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "compact" ] } ], "description": "Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series." } }, "description": "Trellis tile size, row/column facet styling, and shared scales/legends." }, "trendlines": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "columnId", "model" ], "properties": { "columnId": { "type": "string", "description": "Series column id (Y-axis) 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 matching the format panel: linear, quadratic, polynomial, exponential, logarithmic, or power." } } }, { "type": "object", "properties": { "degree": { "type": "number", "description": "Polynomial degree (3–7). Required when model is 'polynomial'." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Trend line stroke styling." }, "label": { "allOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } } }, { "type": "object", "properties": { "text": { "type": "string", "description": "Custom label text." } } } ], "description": "Custom label. Omit the block to hide the label." }, "value": { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } }, "description": "Regression fit value (R²). Omit the block to hide the value." }, "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 value annotation position." }, "fontSize": { "type": "number", "description": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and value annotations." } } } ] }, "description": "Regression trend lines on the chart." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the area chart." }, "yAxis": { "allOf": [ { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "oneOf": [ { "type": "string", "description": "Column ID for a Y-axis series." }, { "allOf": [ { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column ID for a Y-axis series." } } }, { "type": "object", "properties": { "type": { "oneOf": [ { "type": "string", "enum": [ "bar" ] }, { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "scatter" ] } ], "description": "Per-series chart shape: 'bar' (default), 'line', 'area', or 'scatter'." } } } ] } ] }, "description": "Column IDs for the Y-axis series." } } }, { "type": "object", "properties": { "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "Y-axis title, labels, marks, and scale formatting." } } } ], "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order." }, "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "X-axis title, labels, marks, and scale formatting." } } } ], "description": "The column used for the X-axis." }, "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Chart description (subtitle / tooltip text) plus optional styling." }, "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": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend position. Default 'auto'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "colorLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the color legend when both color and size legends apply." }, "sizeLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the size legend when a size channel is present." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, position, and label styling." }, "tooltip": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." }, "multiSeries": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the tooltip lists multiple series. Only supported on bar, line, and area charts." }, "valueFormat": { "oneOf": [ { "type": "string", "enum": [ "percent" ] }, { "type": "string", "enum": [ "number" ] } ], "description": "Tooltip value format. Omit when the chart default applies." } }, "description": "Tooltip display options: column names, multiple series, and percent formatting." }, "stacking": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "stacked" ] }, { "type": "string", "enum": [ "normalized" ] } ], "description": "Stacking mode: 'none' (side-by-side / overlapping), 'stacked' (default — values sum), or 'normalized' (stack scaled to 100%)." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: 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." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Area outline visibility. Omit when shown; only 'hidden' is emitted on read. Not valid on line-chart." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 (on area charts) area outline visibility." }, "points": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Point markers. Omit when shown; only 'hidden' is emitted on read." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } }, "description": "Point markers on the series." } }, "description": "Interpolation, area outline, stroke, point markers, 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": "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 chart." }, "backgroundImage": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported)." } }, "description": "Optional plot-area background image. Url supports dynamic-text {{formula}} references." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "trellis": { "type": "object", "properties": { "column": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis column facet." }, "row": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis row facet." }, "share": { "type": "object", "properties": { "color-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share color legends across the trellis grid. Omit when 'shared' (default)." }, "size-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share size legends across panels. Omit when 'shared'. Scatter with a size channel only." }, "x-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the category-axis scale across panels (UI label follows chart orientation)." }, "y-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the series-axis scale across panels (UI label follows chart orientation)." }, "y-axis-2": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the second series-axis scale. Combo charts with a second value axis only." } }, "description": "Shared scales and legends across trellis panels." }, "tileSize": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "compact" ] } ], "description": "Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series." } }, "description": "Trellis tile size, row/column facet styling, and shared scales/legends." }, "trendlines": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "columnId", "model" ], "properties": { "columnId": { "type": "string", "description": "Series column id (Y-axis) 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 matching the format panel: linear, quadratic, polynomial, exponential, logarithmic, or power." } } }, { "type": "object", "properties": { "degree": { "type": "number", "description": "Polynomial degree (3–7). Required when model is 'polynomial'." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Trend line stroke styling." }, "label": { "allOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } } }, { "type": "object", "properties": { "text": { "type": "string", "description": "Custom label text." } } } ], "description": "Custom label. Omit the block to hide the label." }, "value": { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } }, "description": "Regression fit value (R²). Omit the block to hide the value." }, "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 value annotation position." }, "fontSize": { "type": "number", "description": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and value annotations." } } } ] }, "description": "Regression trend lines on the chart." }, "refMarks": { "type": "array", "items": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type", "axis", "value" ], "properties": { "type": { "type": "string", "enum": [ "line" ], "description": "Reference line." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Position on the axis (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Line stroke styling." } } }, { "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] }, { "allOf": [ { "type": "object", "required": [ "type", "axis", "value", "endValue" ], "properties": { "type": { "type": "string", "enum": [ "band" ], "description": "Reference band." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band start position (constant, column aggregation, or formula)." }, "endValue": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "constant" ] } } }, { "type": "object", "properties": { "value": { "type": "number", "description": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band end position (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Band outline visibility. Set to 'shown' to draw the band border." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Band outline stroke styling." }, "fill": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Band fill color (hex or theme reference)." } }, "description": "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] } ] }, "description": "Reference lines and bands on the chart." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the scatter chart." }, "yAxis": { "allOf": [ { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "oneOf": [ { "type": "string", "description": "Column ID for a Y-axis series." }, { "allOf": [ { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column ID for a Y-axis series." } } }, { "type": "object", "properties": { "type": { "oneOf": [ { "type": "string", "enum": [ "bar" ] }, { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "scatter" ] } ], "description": "Per-series chart shape: 'bar' (default), 'line', 'area', or 'scatter'." } } } ] } ] }, "description": "Column IDs for the Y-axis series." } } }, { "type": "object", "properties": { "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "Y-axis title, labels, marks, and scale formatting." } } } ], "description": "The columns used for the Y-axis. Most scatter plots have one Y-axis column; multiple turn on a series-per-column scatter." } } }, { "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order." }, "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "X-axis title, labels, marks, and scale formatting." } } } ], "description": "The column used for the X-axis." }, "size": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } }, "description": "Optional column whose values drive the bubble size." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: single hex, categorical column, or continuous gradient." }, "dataLabel": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether values appear on chart marks." }, "precision": { "type": "number", "description": "Number of decimal places when labels use percent format." }, "showStroke": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "on" ] }, { "type": "string", "enum": [ "off" ] } ], "description": "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" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Chart description (subtitle / tooltip text) plus optional styling." }, "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": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend position. Default 'auto'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "colorLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the color legend when both color and size legends apply." }, "sizeLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the size legend when a size channel is present." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, position, and label styling." }, "tooltip": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." }, "multiSeries": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the tooltip lists multiple series. Only supported on bar, line, and area charts." }, "valueFormat": { "oneOf": [ { "type": "string", "enum": [ "percent" ] }, { "type": "string", "enum": [ "number" ] } ], "description": "Tooltip value format. Omit when the chart default applies." } }, "description": "Tooltip display options: column names, multiple series, and percent formatting." }, "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 chart." }, "backgroundImage": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported)." } }, "description": "Optional plot-area background image. Url supports dynamic-text {{formula}} references." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "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": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." }, { "oneOf": [ { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Point size preset when a size channel is bound. Maps to store area values (Small/Medium/Large in the format panel)." } ] } }, "description": "Point marker shape and size for the format-panel Point style section." }, "refMarks": { "type": "array", "items": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type", "axis", "value" ], "properties": { "type": { "type": "string", "enum": [ "line" ], "description": "Reference line." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Position on the axis (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Line stroke styling." } } }, { "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] }, { "allOf": [ { "type": "object", "required": [ "type", "axis", "value", "endValue" ], "properties": { "type": { "type": "string", "enum": [ "band" ], "description": "Reference band." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band start position (constant, column aggregation, or formula)." }, "endValue": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "constant" ] } } }, { "type": "object", "properties": { "value": { "type": "number", "description": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band end position (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Band outline visibility. Set to 'shown' to draw the band border." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Band outline stroke styling." }, "fill": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Band fill color (hex or theme reference)." } }, "description": "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] } ] }, "description": "Reference lines and bands on the chart." }, "trellis": { "type": "object", "properties": { "column": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis column facet." }, "row": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis row facet." }, "share": { "type": "object", "properties": { "color-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share color legends across the trellis grid. Omit when 'shared' (default)." }, "size-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share size legends across panels. Omit when 'shared'. Scatter with a size channel only." }, "x-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the category-axis scale across panels (UI label follows chart orientation)." }, "y-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the series-axis scale across panels (UI label follows chart orientation)." }, "y-axis-2": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the second series-axis scale. Combo charts with a second value axis only." } }, "description": "Shared scales and legends across trellis panels." }, "tileSize": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "compact" ] } ], "description": "Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series." } }, "description": "Trellis tile size, row/column facet styling, and shared scales/legends." }, "trendlines": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "columnId", "model" ], "properties": { "columnId": { "type": "string", "description": "Series column id (Y-axis) 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 matching the format panel: linear, quadratic, polynomial, exponential, logarithmic, or power." } } }, { "type": "object", "properties": { "degree": { "type": "number", "description": "Polynomial degree (3–7). Required when model is 'polynomial'." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Trend line stroke styling." }, "label": { "allOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } } }, { "type": "object", "properties": { "text": { "type": "string", "description": "Custom label text." } } } ], "description": "Custom label. Omit the block to hide the label." }, "value": { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } }, "description": "Regression fit value (R²). Omit the block to hide the value." }, "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 value annotation position." }, "fontSize": { "type": "number", "description": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and value annotations." } } } ] }, "description": "Regression trend lines on the chart." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the combo chart." }, "yAxis": { "allOf": [ { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "oneOf": [ { "type": "string", "description": "Column ID for a Y-axis series." }, { "allOf": [ { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column ID for a Y-axis series." } } }, { "type": "object", "properties": { "type": { "oneOf": [ { "type": "string", "enum": [ "bar" ] }, { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "scatter" ] } ], "description": "Per-series chart shape: 'bar' (default), 'line', 'area', or 'scatter'." } } } ] } ] }, "description": "Column IDs for the Y-axis series." } } }, { "type": "object", "properties": { "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "Y-axis title, labels, marks, and scale formatting." } } } ], "description": "The columns used for the Y-axis. Each entry can specify its own `type` (bar / line / area / scatter); default is bar." } } }, { "type": "object", "properties": { "yAxis2": { "allOf": [ { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "type": "string", "description": "Column ID for a series assigned to Y-axis 2." }, "description": "Column IDs for series on the secondary Y-axis." } } }, { "type": "object", "properties": { "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "Y-axis 2 title, labels, marks, scale, and tick spacing." } } } ], "description": "Secondary Y-axis: series assignment (`columnIds`) and axis formatting (`format`). Combo only." }, "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order." }, "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "X-axis title, labels, marks, and scale formatting." } } } ], "description": "The column used for the X-axis." }, "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Chart description (subtitle / tooltip text) plus optional styling." }, "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": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend position. Default 'auto'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "colorLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the color legend when both color and size legends apply." }, "sizeLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the size legend when a size channel is present." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, position, and label styling." }, "tooltip": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." }, "multiSeries": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the tooltip lists multiple series. Only supported on bar, line, and area charts." }, "valueFormat": { "oneOf": [ { "type": "string", "enum": [ "percent" ] }, { "type": "string", "enum": [ "number" ] } ], "description": "Tooltip value format. Omit when the chart default applies." } }, "description": "Tooltip display options: column names, multiple series, and percent formatting." }, "stacking": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "stacked" ] }, { "type": "string", "enum": [ "normalized" ] } ], "description": "Stacking mode: 'none' (side-by-side / overlapping), 'stacked' (default — values sum), or 'normalized' (stack scaled to 100%)." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: single hex, categorical column, or continuous gradient." }, "barStyle": { "type": "object", "properties": { "cornerRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Bar corner shape: 'square' (default), 'round', or 'pill'." } }, "description": "Bar corner shape for bar layers: 'square' (default), 'round', or 'pill'." }, "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." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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": "Number of decimal places when labels include percentages." }, "showStroke": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "on" ] }, { "type": "string", "enum": [ "off" ] } ], "description": "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": "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 values and labels to show on total (aggregate) labels." }, "orient": { "oneOf": [ { "type": "string", "enum": [ "horizontal" ] }, { "type": "string", "enum": [ "vertical" ] } ], "description": "Text direction for total labels." } }, "description": "Options for aggregate total labels when the combo includes bar layers." }, "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. Layer-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": "Gap width between individual bars in a band (format panel: Gap width)." }, "betweenSets": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Gap between bar clusters when the chart is clustered (format panel: Gap between sets)." } }, "description": "Bar gap width and spacing between clustered bar sets on combo bar layers." }, "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 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." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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 area layer labels." }, "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": "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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": "Number of decimal places when labels include percentages." }, "showStroke": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "on" ] }, { "type": "string", "enum": [ "off" ] } ], "description": "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": "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 values and labels to show on total (aggregate) labels." }, "orient": { "oneOf": [ { "type": "string", "enum": [ "horizontal" ] }, { "type": "string", "enum": [ "vertical" ] } ], "description": "Text direction for total labels." } }, "description": "Options for aggregate total labels on 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." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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 line layer labels." }, "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": "Outline around data labels." } } }, "scatter": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether values appear on chart marks." }, "precision": { "type": "number", "description": "Number of decimal places when labels use percent format." }, "showStroke": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "on" ] }, { "type": "string", "enum": [ "off" ] } ], "description": "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 settings grouped by layer: 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": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." }, { "oneOf": [ { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Point size preset when a size channel is bound. Maps to store area values (Small/Medium/Large in the format panel)." } ] } }, "description": "Default point marker shape and size for scatter layers." }, "seriesPointStyle": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Y-axis column id for a combo scatter layer." } } }, { "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": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." }, { "oneOf": [ { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Point size preset when a size channel is bound. Maps to store area values (Small/Medium/Large in the format panel)." } ] } } } ] }, "description": "Per-series point style overrides on combo charts (scatter layers only). Each entry lists only fields that differ from `pointStyle`." }, "backgroundImage": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported)." } }, "description": "Optional plot-area background image. Url supports dynamic-text {{formula}} references." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Area outline visibility. Omit when shown; only 'hidden' is emitted on read. Not valid on line-chart." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 (on area charts) area outline visibility." }, "points": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Point markers. Omit when shown; only 'hidden' is emitted on read." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } }, "description": "Point markers on the series." } }, "description": "Default line/area layer interpolation, stroke, points, and null handling." }, "seriesLineAreaStyle": { "type": "object", "additionalProperties": { "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Area outline visibility. Omit when shown; only 'hidden' is emitted on read. Not valid on line-chart." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 (on area charts) area outline visibility." }, "points": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Point markers. Omit when shown; only 'hidden' is emitted on read." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } }, "description": "Point markers on the series." } } }, "description": "Per-series line/area style overrides on combo charts (Y-axis column id keys)." }, "refMarks": { "type": "array", "items": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type", "axis", "value" ], "properties": { "type": { "type": "string", "enum": [ "line" ], "description": "Reference line." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Position on the axis (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Line stroke styling." } } }, { "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] }, { "allOf": [ { "type": "object", "required": [ "type", "axis", "value", "endValue" ], "properties": { "type": { "type": "string", "enum": [ "band" ], "description": "Reference band." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band start position (constant, column aggregation, or formula)." }, "endValue": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "constant" ] } } }, { "type": "object", "properties": { "value": { "type": "number", "description": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band end position (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Band outline visibility. Set to 'shown' to draw the band border." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Band outline stroke styling." }, "fill": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Band fill color (hex or theme reference)." } }, "description": "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] } ] }, "description": "Reference lines and bands on the chart." }, "trellis": { "type": "object", "properties": { "column": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis column facet." }, "row": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis row facet." }, "share": { "type": "object", "properties": { "color-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share color legends across the trellis grid. Omit when 'shared' (default)." }, "size-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share size legends across panels. Omit when 'shared'. Scatter with a size channel only." }, "x-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the category-axis scale across panels (UI label follows chart orientation)." }, "y-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the series-axis scale across panels (UI label follows chart orientation)." }, "y-axis-2": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the second series-axis scale. Combo charts with a second value axis only." } }, "description": "Shared scales and legends across trellis panels." }, "tileSize": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "compact" ] } ], "description": "Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series." } }, "description": "Trellis tile size, row/column facet styling, and shared scales/legends." }, "trendlines": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "columnId", "model" ], "properties": { "columnId": { "type": "string", "description": "Series column id (Y-axis) 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 matching the format panel: linear, quadratic, polynomial, exponential, logarithmic, or power." } } }, { "type": "object", "properties": { "degree": { "type": "number", "description": "Polynomial degree (3–7). Required when model is 'polynomial'." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Trend line stroke styling." }, "label": { "allOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } } }, { "type": "object", "properties": { "text": { "type": "string", "description": "Custom label text." } } } ], "description": "Custom label. Omit the block to hide the label." }, "value": { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } }, "description": "Regression fit value (R²). Omit the block to hide the value." }, "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 value annotation position." }, "fontSize": { "type": "number", "description": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and value annotations." } } } ] }, "description": "Regression trend lines on the chart." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "Actions triggered by interacting with this element." } } } ], "description": "", "title": "Combo 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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the point map." }, "latitude": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } }, "description": "The column whose values are point latitudes (degrees, WGS84)." }, "longitude": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } }, "description": "The column whose values are point longitudes (degrees, WGS84)." } } }, { "type": "object", "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`. Maps do not support alignment." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Map description (subtitle / tooltip text) plus optional styling." }, "legend": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend corner position on maps." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, corner 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": "Allow pan and zoom on the map. Omit when shown (default)." } } }, { "type": "object", "required": [ "baseStyle", "styleUrl" ], "properties": { "baseStyle": { "type": "string", "enum": [ "custom" ], "description": "Custom Mapbox style; requires `styleUrl`." }, "styleUrl": { "type": "string", "description": "Mapbox style URL. Required when `baseStyle` is `custom`." } } } ] }, { "type": "object" }, { "oneOf": [ { "type": "object" }, { "type": "object" }, { "type": "object" } ] } ] }, { "type": "null" } ], "description": "Map style: base style, custom URL, allow pan/zoom, and 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": "Min and max point diameters in pixels when a size channel is bound. Omit when default [3, 15]." } ] } } }, { "type": "null" } ], "description": "Point mark opacity and size for the format-panel Point style section." }, "size": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } }, "description": "Optional column whose values drive the bubble size." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: single hex, categorical column, or continuous gradient." }, "label": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } } }, "description": "Optional columns rendered as text labels next to each point." }, "tooltip": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } } }, "description": "Optional columns shown in the hover tooltip." }, "tooltipFormat": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." } }, "description": "Tooltip display options. Maps use `tooltip` for hover column refs; use `tooltipFormat` for format-panel settings." }, "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 chart." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the region map." }, "region": { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "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": "Which kind of region the column represents (country, us-state, etc.). Sets the column's geo-region semantic role." } } } ], "description": "The region column and the kind of region it contains." } } }, { "type": "object", "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`. Maps do not support alignment." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Map description (subtitle / tooltip text) plus optional styling." }, "legend": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend corner position on maps." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, corner 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": "Allow pan and zoom on the map. Omit when shown (default)." } } }, { "type": "object", "required": [ "baseStyle", "styleUrl" ], "properties": { "baseStyle": { "type": "string", "enum": [ "custom" ], "description": "Custom Mapbox style; requires `styleUrl`." }, "styleUrl": { "type": "string", "description": "Mapbox style URL. Required when `baseStyle` is `custom`." } } } ] }, { "type": "object" }, { "oneOf": [ { "type": "object" }, { "type": "object" }, { "type": "object" } ] } ] }, { "type": "null" } ], "description": "Map style: base style, custom URL, allow pan/zoom, and 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": "Region fill opacity for the format-panel Region style section." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: single hex, categorical column, or continuous gradient." }, "label": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } } }, "description": "Optional columns rendered as text labels on each region." }, "tooltip": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } } }, "description": "Optional columns shown in the hover tooltip." }, "tooltipFormat": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." } }, "description": "Tooltip display options. Maps use `tooltip` for hover column refs; use `tooltipFormat` for format-panel settings." }, "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 chart." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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." }, "kind": { "type": "string", "enum": [ "geography-map" ] }, "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the geography map." }, "geography": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } }, "description": "The column whose values are GeoJSON geometries (Point, Polygon, MultiPolygon, LineString, etc.)." } } }, { "type": "object", "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`. Maps do not support alignment." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Map description (subtitle / tooltip text) plus optional styling." }, "legend": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend corner position on maps." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, corner 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": "Allow pan and zoom on the map. Omit when shown (default)." } } }, { "type": "object", "required": [ "baseStyle", "styleUrl" ], "properties": { "baseStyle": { "type": "string", "enum": [ "custom" ], "description": "Custom Mapbox style; requires `styleUrl`." }, "styleUrl": { "type": "string", "description": "Mapbox style URL. Required when `baseStyle` is `custom`." } } } ] }, { "type": "object" }, { "oneOf": [ { "type": "object" }, { "type": "object" }, { "type": "object" } ] } ] }, { "type": "null" } ], "description": "Map style: base style, custom URL, allow pan/zoom, and 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": "Feature mark opacity and point size for the format-panel Feature style section." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: single hex, categorical column, or continuous gradient." }, "tooltip": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } } }, "description": "Optional columns shown in the hover tooltip." }, "tooltipFormat": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." } }, "description": "Tooltip display options. Maps use `tooltip` for hover column refs; use `tooltipFormat` for format-panel settings." }, "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 chart." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 data source for the pivot 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "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" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Pivot description (subtitle / tooltip text) plus optional styling." }, "noDataText": { "type": "string", "description": "Custom message rendered when the chart has no data." }, "rowsBy": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order for this shelf entry." } } } ] }, "description": "Column IDs placed on the row shelf." }, "columnsBy": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order for this shelf entry." } } } ] }, "description": "Column IDs placed on the column shelf." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "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": "A Sling formula returning a boolean. The formula may reference any column on the sheet, not just the styled columns." } } } ] }, { "type": "object", "properties": { "style": { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Cell background color (hex)." }, "color": { "type": "string", "description": "Font color (hex)." }, "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 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": "Number or datetime format override for the displayed value." } } } } } ] }, { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "backgroundScale" ] } } }, { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "type": "string" }, "description": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "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": "Apply this formatting to data cells. Defaults to true at render." }, "includeSubtotals": { "type": "boolean", "description": "Apply this formatting to subtotal rows. Defaults to false." }, "includeGrandTotals": { "type": "boolean", "description": "Apply this formatting to grand total rows. Defaults to false." } } } ] }, "description": "Conditional formatting applied to value cells of this pivot. Order matters: later entries apply on top of earlier ones." }, "tableStyle": { "type": "object", "properties": { "preset": { "oneOf": [ { "type": "string", "enum": [ "spreadsheet" ] }, { "type": "string", "enum": [ "presentation" ] } ], "description": "Table preset: 'spreadsheet' or 'presentation'. Omit when spreadsheet (default)." }, "cellSpacing": { "oneOf": [ { "type": "string", "enum": [ "extra-small" ] }, { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Cell spacing preset: 'extra-small', 'small', 'medium', or 'large'." }, "gridLines": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "vertical" ] }, { "type": "string", "enum": [ "horizontal" ] }, { "type": "string", "enum": [ "all" ] } ], "description": "Grid lines: 'none', 'vertical', 'horizontal', or 'all'." }, "banding": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Row banding visibility: 'shown' or 'hidden'." }, "bandingColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "autofitColumns": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Autofit column widths (level table only): 'shown' or 'hidden'." }, "outerBorder": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Outer table border: 'shown' or 'hidden'. Maps to inverted store `hideOuterBorder`." }, "headerDividerColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "heavyVerticalDividers": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Heavier vertical group dividers (pivot only): 'shown' or 'hidden'." }, "heavyHorizontalDividers": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Heavier horizontal group dividers (pivot only): 'shown' or 'hidden'." }, "textStyles": { "type": "object", "properties": { "header": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "cell": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "columnHeader": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "rowHeader": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } } } } }, "description": "Table style: grid preset, spacing, grid lines, banding, dividers, and per-tab text styles." }, "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Default sparkline mark formatting applied to all sparkline columns (Format tab apply-to-all)." }, "tableComponents": { "type": "object", "description": "Table component visibility toggles (column headers, row headers). Each key is `shown` or `hidden`; omit when shown (default)." }, "totals": { "type": "object", "properties": { "subTotalColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "subTotalBackgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "subTotalFontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "showSubtotals": { "oneOf": [ { "type": "string", "enum": [ "always" ] }, { "type": "string", "enum": [ "when-collapsed" ] } ], "description": "Subtotal default visibility: 'always' (default) or 'when-collapsed'." }, "grandTotalColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "grandTotalBackgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "grandTotalFontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "showGrandTotals": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ] }, "totalPosition": { "oneOf": [ { "type": "string", "enum": [ "first" ] }, { "type": "string", "enum": [ "last" ] } ], "description": "Total position: 'first' or 'last' (default)." } }, "description": "Pivot total row/column styling and default visibility (Format tab Totals section)." }, "display": { "type": "object", "properties": { "emptyCellDisplay": { "type": "string", "description": "Text shown in empty pivot value cells." }, "measureShelfPosition": { "type": "number", "description": "0-based position of the Values shelf among row/column dimension fields; -1 = last (default)." }, "repeatRowLabels": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether row labels repeat on each row." }, "rowLayout": { "oneOf": [ { "type": "string", "enum": [ "single-column" ] }, { "type": "string", "enum": [ "separate-columns" ] } ], "description": "Row dimension layout: '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": "Value layout: 'stacked' in the row shelf or 'side-by-side' in the column shelf (default)." } }, "description": "Pivot display and layout: empty cell text, value stacking, measure labels, row layout, measure shelf position, and repeat row labels." }, "adhocCalcs": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "id", "inColumn", "position" ], "properties": { "id": { "type": "string", "description": "Stable identifier for the ad hoc calculation row. Also the adhoc channel column ID." }, "inColumn": { "type": "string", "description": "Row dimension from the panel “In column” field, or 'grand-row-total'." }, "position": { "type": "string", "enum": [ "above", "below" ], "description": "Panel “Position”: 'above' or 'below' the attach row." } } }, { "type": "object", "properties": { "name": { "type": "string", "description": "Panel “Calculation name” (column display name)." }, "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": "Row dimension column ID for this parent level (Format panel “In” section)." }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ], "description": "Row dimension value at this parent level." } } }, "description": "Panel “In” section: parent row dimension values above the attach level." }, "anchorRow": { "oneOf": [ { "type": "string", "enum": [ "subtotal" ] }, { "type": "string", "enum": [ "data" ] } ], "description": "Row the calc anchors to: 'subtotal' when placed at a subtotal or grand-total row; omit for a data row." }, "calculations": { "type": "array", "items": { "type": "object", "required": [ "columnId", "formula" ], "properties": { "columnId": { "type": "string", "description": "Value column ID from the pivot values shelf." }, "formula": { "type": "string", "description": "Formula override for this value column in the ad hoc row." } } }, "description": "Per-value-column formula overrides for this ad hoc row." } } } ] }, "description": "Ad hoc calculation rows inserted into the pivot row axis." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "Actions triggered by interacting with this element." } } } ], "description": "", "title": "Pivot Table" } ] }, { "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-text {{formula}} references." } } }, { "type": "object", "properties": { "appearance": { "oneOf": [ { "type": "string", "enum": [ "filled" ] }, { "type": "string", "enum": [ "outline" ] }, { "type": "string", "enum": [ "text" ] } ], "description": "Visual style: filled (default), outline, or text." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] }, { "type": "string", "enum": [ "stretch" ] } ], "description": "Horizontal alignment: left, center, right, or stretch." }, "size": { "oneOf": [ { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Button size: small, medium, or large." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner radius: square, round, or pill. Omit to inherit the workbook theme." }, "fillColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Background fill color: hex or theme reference." }, "fontColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Label text color: hex or theme reference." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Label font weight: 'normal' or 'bold'." }, "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "Actions triggered by interacting with this button." } } } ], "description": "", "title": "Button" }, { "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 embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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" }, { "allOf": [ { "type": "object", "required": [ "id", "kind" ], "properties": { "id": { "type": "string", "description": "The identifier of the container." }, "kind": { "type": "string", "enum": [ "container" ] } } }, { "type": "object", "properties": { "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "backgroundImage": { "allOf": [ { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the background image. Supports dynamic-text {{formula}} references. Must be an external URL (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 its container: contain, cover, none, scale-down, or stretch." }, "horizontalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Horizontal alignment within the container: start, middle, or end." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical alignment within the container: start, middle, or end." }, "tiling": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "repeat" ] } ], "description": "Tiling behavior: 'none' (single image, default) or 'repeat' (tiled to fill the container)." } }, "description": "Visual customization: fit, alignment, and tiling." } } } ], "description": "Optional background image for the container. Url supports dynamic-text {{formula}} references." } } } ], "description": "", "title": "Container" }, { "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": "Orientation of the divider. Defaults to horizontal." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Alignment along the cross-axis. Defaults to middle." }, "style": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Stroke color as a hex string (e.g. \"#e0e0e0\") or theme reference." }, "width": { "type": "number", "description": "Stroke thickness in pixels." }, "strokeStyle": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: solid, dashed, or dotted." } }, "description": "Visual customization of the divider stroke." } } } ], "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", "url" ], "properties": { "id": { "type": "string", "description": "The identifier of the image." }, "kind": { "type": "string", "enum": [ "image" ] }, "url": { "type": "string", "description": "The URL of the image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported)." } } }, { "type": "object", "properties": { "alt": { "type": "string", "description": "Alternative text for the image." }, "link": { "type": "string", "description": "Optional link URL the image redirects to when clicked." }, "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 its container: contain, cover, none, scale-down, or stretch." }, "horizontalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Horizontal alignment within the container: start, middle, or end." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical alignment within the container: start, middle, or end." }, "tiling": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "repeat" ] } ], "description": "Tiling behavior: 'none' (single image, default) or 'repeat' (tiled to fill the container)." } } }, { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "rectangle" ] }, { "type": "string", "enum": [ "circle" ] } ], "description": "Image shape: rectangle or circle." } } } ] }, { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ] } ], "description": "Visual customization: fit, alignment, shape, and tiling." } } } ], "description": "", "title": "Image" }, { "allOf": [ { "type": "object", "required": [ "id", "kind", "source", "inputMode" ], "properties": { "id": { "type": "string", "description": "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": "Source of the input-table. `empty` provisions a fresh warehouse table." }, "inputMode": { "oneOf": [ { "type": "string", "enum": [ "edit" ], "description": "workbook editors only, in draft mode" }, { "type": "string", "enum": [ "explore" ], "description": "users with explore or greater permission, in published view" }, { "type": "string", "enum": [ "view" ], "description": "all users, in published view" } ], "description": "data entry permissions" } } }, { "type": "object", "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display title. A bare string, an object `{ text, ...styling }` for font size/color/alignment/weight, 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": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } } } ], "description": "Description (subtitle / tooltip text) plus optional styling. A bare string for text-only." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Element style: background color, border, border radius, and padding." }, "noDataText": { "type": "string", "description": "Label displayed when the input table has no data." }, "tableComponents": { "type": "object", "properties": { "table": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Input table body grid." }, "summaryBar": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Input table summary bar." } }, "description": "Visibility of the table grid and summary bar." }, "tableStyle": { "type": "object", "properties": { "preset": { "oneOf": [ { "type": "string", "enum": [ "spreadsheet" ] }, { "type": "string", "enum": [ "presentation" ] } ], "description": "Table preset: 'spreadsheet' or 'presentation'. Omit when spreadsheet (default)." }, "cellSpacing": { "oneOf": [ { "type": "string", "enum": [ "extra-small" ] }, { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Cell spacing preset: 'extra-small', 'small', 'medium', or 'large'." }, "gridLines": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "vertical" ] }, { "type": "string", "enum": [ "horizontal" ] }, { "type": "string", "enum": [ "all" ] } ], "description": "Grid lines: 'none', 'vertical', 'horizontal', or 'all'." }, "banding": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Row banding visibility: 'shown' or 'hidden'." }, "bandingColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "autofitColumns": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Autofit column widths (level table only): 'shown' or 'hidden'." }, "outerBorder": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Outer table border: 'shown' or 'hidden'. Maps to inverted store `hideOuterBorder`." }, "headerDividerColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "heavyVerticalDividers": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Heavier vertical group dividers (pivot only): 'shown' or 'hidden'." }, "heavyHorizontalDividers": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Heavier horizontal group dividers (pivot only): 'shown' or 'hidden'." }, "textStyles": { "type": "object", "properties": { "header": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "cell": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "columnHeader": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "rowHeader": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } } } } }, "description": "Table style: grid preset, spacing, grid lines, banding, autofit, dividers, and per-tab text styles." }, "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": "Protocol-managed system column id (e.g. `ID`, `CREATED_AT`). Its data type is fixed by the input-table protocol." } } }, { "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." } } } ] }, { "allOf": [ { "type": "object", "required": [ "id", "key" ], "properties": { "id": { "type": "string", "description": "Identifier of the key column in this input-table." }, "key": { "type": "string", "description": "Id of the source column (on `source.from`) this key binds to. Immutable once the input-table is created." } } }, { "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." } } } ] }, { "allOf": [ { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "description": "Warehouse column identifier." }, "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": "Allowed values for the column, presented as a single-select dropdown." }, "valuesFrom": { "type": "object", "required": [ "element", "column" ], "properties": { "element": { "type": "string", "description": "Id of a sibling element supplying the option values." }, "column": { "type": "string", "description": "Id of the column on that element to read values from." } }, "description": "Column-sourced option list (alternative to inline `values`)." }, "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 bound for a number or datetime column (datetime bounds are ISO-8601 dates)." }, "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": "Allowed file MIME types (file columns only); an absent or empty list accepts everything. Passing any one MIME type of a multi-format family (e.g. `application/msword`) selects the whole family, so a round-trip may expand the list to every MIME type in each selected family." }, "pills": { "oneOf": [ { "type": "string", "enum": [ "single-color" ] }, { "type": "string", "enum": [ "color-by-option" ] } ], "description": "Display a select column as pills. `single-color`: one shared color; `color-by-option`: a color per option. Absent shows 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": "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." } } } ] }, { "allOf": [ { "type": "object", "required": [ "id", "formula" ], "properties": { "id": { "type": "string", "description": "Identifier of the formula 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": "Columns of 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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "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": "A Sling formula returning a boolean. The formula may reference any column on the sheet, not just the styled columns." } } } ] }, { "type": "object", "properties": { "style": { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Cell background color (hex)." }, "color": { "type": "string", "description": "Font color (hex)." }, "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 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": "Number or datetime format override for the displayed value." } } } } } ] }, { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "backgroundScale" ] } } }, { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "type": "string" }, "description": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "order": { "oneOf": [ { "type": "string", "enum": [ "descending" ] }, { "type": "string", "enum": [ "ascending" ] } ] }, "valueLabels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "string", "enum": [ "shown" ] } ] } } } ] } ] }, "description": "Conditional formatting applied to columns of this input-table. Order matters: later entries apply on top of earlier ones." }, "summary": { "type": "array", "items": { "type": "string" }, "description": "Identifiers of the columns shown as aggregates in the summary bar. Each id 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 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 input-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": "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 input-table and their configurations." } } } ], "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": "Identifier of the custom 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 identifier of the element that provides data to the plugin." } } }, { "type": "object", "properties": { "groupingId": { "type": "string", "description": "The identifier of a grouping on the source element to read data at. Omit to read ungrouped (base) data." } } } ], "description": "", "title": "Element reference" }, { "allOf": [ { "type": "object", "required": [ "kind", "source" ], "properties": { "kind": { "type": "string", "enum": [ "column" ] }, "source": { "type": "string", "description": "Name of the element-reference config entry that provides the columns." } } }, { "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 identifier of the control whose value feeds this config entry." } }, "description": "", "title": "Control reference" } ] } ] }, "description": "Plugin inputs, keyed by the config name the plugin declares. Values are literals, or `kind`-tagged references to elements, columns, or controls. The set of meaningful keys is defined by the plugin itself at runtime and is not validated here." }, "style": { "type": "object", "properties": { "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Background color as a hex string (e.g. \"#ffffff\") or theme reference." } }, "description": "Visual customization of the plugin element." } } } ], "description": "", "title": "Plugin" }, { "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 for same-window), inline HTML /// 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

wrapper, e.g.

…

(aligned headings too:

…

); 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": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical alignment of body content within the tile: 'start' (top), 'middle', or 'end' (bottom). Default 'start'." }, "overflow": { "oneOf": [ { "type": "string", "enum": [ "clip" ] }, { "type": "string", "enum": [ "scroll" ] } ], "description": "Overflow behavior when content exceeds the tile: 'clip' (cut off, default) or 'scroll' (scrollbar)." } } } ], "description": "", "title": "Text" } ] }, "description": "The elements inside 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": "Overlay width breakpoint: x-small, small, medium, large, or x-large." }, "header": { "type": "object", "properties": { "title": { "type": "string", "description": "Header title. Supports dynamic-text {{formula}} references." }, "showCloseIcon": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the header shows the dismiss (X) icon: 'shown' or 'hidden'." } }, "description": "Header configuration: 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 this CTA button is shown: 'shown' or 'hidden'." }, "text": { "type": "string", "description": "CTA button label. Supports dynamic-text {{formula}} references." } }, "description": "Primary footer CTA button." }, "secondaryCta": { "type": "object", "properties": { "visible": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether this CTA button is shown: 'shown' or 'hidden'." }, "text": { "type": "string", "description": "CTA button label. Supports dynamic-text {{formula}} references." } }, "description": "Secondary footer CTA button." } }, "description": "Footer with primary/secondary CTA buttons." } } } ], "description": "Modal presentation: width, header, and footer CTA buttons." }, "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "Actions fired by the modal (primary/secondary CTA click, or on close)." }, "backgroundImage": { "allOf": [ { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the background image. Supports dynamic-text {{formula}} references. Must be an external URL (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 its container: contain, cover, none, scale-down, or stretch." }, "horizontalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Horizontal alignment within the container: start, middle, or end." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical alignment within the container: start, middle, or end." }, "tiling": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "repeat" ] } ], "description": "Tiling behavior: 'none' (single image, default) or 'repeat' (tiled to fill the container)." } }, "description": "Visual customization: fit, alignment, and tiling." } } } ], "description": "Optional background image for the modal. Url supports dynamic-text {{formula}} references." } } } ] }, { "allOf": [ { "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": [ { "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": [ { "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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, { "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": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical alignment of cell content: start, middle, or end." }, "width": { "type": "number", "description": "Column width in pixels when overriding auto-sizing." }, "backgroundColor": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Cell background: `{ kind: theme, ref }` or hex `#rgb` / `#rrggbb` only." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Cell text color: `{ kind: theme, ref }` or hex only." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip' (no wrap)." } }, "description": "Grid presentation for this column (alignment, width, colors, wrap)." }, "link": { "oneOf": [ { "type": "object", "required": [ "kind", "columnId" ], "properties": { "kind": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "External id of a column in this table whose text values are the hyperlink URL." } } }, { "type": "object", "required": [ "kind", "formula" ], "properties": { "kind": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string", "description": "Text-typed formula for the hyperlink URL." } } } ], "description": "Hyperlink target for this column: another column’s text values or a custom URL formula." } } } ] }, "description": "The columns of the table and their formulas. Optional columns[].style holds grid presentation (enums, not booleans, for toggles)." }, "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } } } ], "description": "Table description (subtitle / tooltip text) plus optional styling." }, "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": "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." }, "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." } } } ] }, "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "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": "A Sling formula returning a boolean. The formula may reference any column on the sheet, not just the styled columns." } } } ] }, { "type": "object", "properties": { "style": { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Cell background color (hex)." }, "color": { "type": "string", "description": "Font color (hex)." }, "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 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": "Number or datetime format override for the displayed value." } } } } } ] }, { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "backgroundScale" ] } } }, { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "type": "string" }, "description": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "order": { "oneOf": [ { "type": "string", "enum": [ "descending" ] }, { "type": "string", "enum": [ "ascending" ] } ] }, "valueLabels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "string", "enum": [ "shown" ] } ] } } } ] } ] }, "description": "Conditional formatting applied to columns of this table. Order matters: later entries apply on top of earlier ones." }, "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Default sparkline mark formatting applied to all sparkline columns (Format tab apply-to-all)." }, "tableComponents": { "type": "object", "description": "Table component visibility toggles (summary bar, collapsed columns, etc.). Each key is `shown` or `hidden`; omit when shown (default)." }, "tableStyle": { "type": "object", "properties": { "preset": { "oneOf": [ { "type": "string", "enum": [ "spreadsheet" ] }, { "type": "string", "enum": [ "presentation" ] } ], "description": "Table preset: 'spreadsheet' or 'presentation'. Omit when spreadsheet (default)." }, "cellSpacing": { "oneOf": [ { "type": "string", "enum": [ "extra-small" ] }, { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Cell spacing preset: 'extra-small', 'small', 'medium', or 'large'." }, "gridLines": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "vertical" ] }, { "type": "string", "enum": [ "horizontal" ] }, { "type": "string", "enum": [ "all" ] } ], "description": "Grid lines: 'none', 'vertical', 'horizontal', or 'all'." }, "banding": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Row banding visibility: 'shown' or 'hidden'." }, "bandingColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "autofitColumns": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Autofit column widths (level table only): 'shown' or 'hidden'." }, "outerBorder": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Outer table border: 'shown' or 'hidden'. Maps to inverted store `hideOuterBorder`." }, "headerDividerColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "heavyVerticalDividers": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Heavier vertical group dividers (pivot only): 'shown' or 'hidden'." }, "heavyHorizontalDividers": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Heavier horizontal group dividers (pivot only): 'shown' or 'hidden'." }, "textStyles": { "type": "object", "properties": { "header": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "cell": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "columnHeader": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "rowHeader": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } } } } }, "description": "Table style: grid preset, spacing, grid lines, banding, autofit, dividers, and per-tab text styles." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "Actions triggered by interacting with this element." } } } ], "description": "", "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the KPI." }, "value": { "allOf": [ { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column id bound to the KPI value shelf." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide the KPI value number. Only applies when a comparison is configured. Omit when shown." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Value font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Value font size in pixels, or 'auto'." } } } ], "description": "KPI value shelf binding (`columnId`) plus optional Value-section styling." } } }, { "type": "object", "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Title font size in pixels, or 'auto' to let the viz pick." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size (numeric or `auto`), color, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`. KPI does not support alignment." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Description font size in pixels, or 'auto' to let the viz pick." } }, "description": "KPI description (subtitle / tooltip text) plus optional styling. KPI accepts `auto` font size." }, "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 chart." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "layout": { "type": "object", "properties": { "anchor": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Alignment: 'start', 'middle', or 'end'." }, "verticalAnchor": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical alignment: 'start', 'middle', or 'end'." }, "titleOrient": { "oneOf": [ { "type": "string", "enum": [ "top" ] }, { "type": "string", "enum": [ "bottom" ] } ], "description": "Title position: 'top' or 'bottom'." }, "comparisonValueOrient": { "oneOf": [ { "type": "string", "enum": [ "right" ] }, { "type": "string", "enum": [ "below" ] } ], "description": "Comparison value position: 'right' or 'below'." } }, "description": "KPI layout: alignment, title position, and comparison position." }, "comparison": { "type": "object", "properties": { "display": { "oneOf": [ { "type": "string", "enum": [ "percentage" ] }, { "type": "string", "enum": [ "delta" ] }, { "type": "string", "enum": [ "relative" ] }, { "type": "string", "enum": [ "absolute" ] } ], "description": "Comparison display: 'percentage', 'delta', 'relative', or 'absolute'." }, "direction": { "oneOf": [ { "type": "string", "enum": [ "higher" ] }, { "type": "string", "enum": [ "lower" ] }, { "type": "string", "enum": [ "none" ] } ], "description": "Comparison direction: 'higher', 'lower', or 'none'." }, "colorGood": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "colorNeutral": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "colorBad": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "arrow": { "type": "string", "enum": [ "hidden" ], "description": "Hide the comparison arrow. Omit when shown." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Comparison font size in pixels, or 'auto'." }, "label": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "string" } ], "description": "Comparison label text, or 'hidden' to hide the label." }, "labelColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "noDateText": { "type": "string", "description": "Label shown when the comparison date is invalid." } }, "description": "KPI comparison formatting (display, direction, colors, label)." }, "trend": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide the trend sparkline. Omit when shown." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "area" ] } ], "description": "Trend shape: 'line' or 'area'." }, "areaStyle": { "oneOf": [ { "type": "string", "enum": [ "gradient" ] }, { "type": "string", "enum": [ "solid" ] } ], "description": "Area fill style: 'gradient' or 'solid'. Only applies when shape is 'area'." }, "valueColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "comparisonColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "tooltip": { "type": "string", "enum": [ "shown" ], "description": "Explicitly enable a feature whose default is off." }, "xAxis": { "type": "string", "enum": [ "shown" ], "description": "Explicitly enable a feature whose default is off." }, "yAxis": { "type": "string", "enum": [ "shown" ], "description": "Explicitly enable a feature whose default is off." }, "noDataText": { "type": "string", "description": "Label shown when the trend has no data." } }, "description": "KPI trend sparkline formatting." }, "timeline": { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column id bound to the KPI timeline shelf (enables the trend sparkline)." } }, "description": "KPI timeline shelf binding (date column for the trend sparkline)." }, "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": "Period-over-period comparison grain (requires timeline). Mutually exclusive with comparisonColumn." }, "comparisonColumn": { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column id bound to the KPI comparison shelf (compare value to another measure)." } }, "description": "Comparison shelf binding (compare value to another measure). Mutually exclusive with periodComparison." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 data source for the bar 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the bar chart." }, "yAxis": { "allOf": [ { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "oneOf": [ { "type": "string", "description": "Column ID for a Y-axis series." }, { "allOf": [ { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column ID for a Y-axis series." } } }, { "type": "object", "properties": { "type": { "oneOf": [ { "type": "string", "enum": [ "bar" ] }, { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "scatter" ] } ], "description": "Per-series chart shape: 'bar' (default), 'line', 'area', or 'scatter'." } } } ] } ] }, "description": "Column IDs for the Y-axis series." } } }, { "type": "object", "properties": { "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "Y-axis title, labels, marks, and scale formatting." } } } ], "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order." }, "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "X-axis title, labels, marks, and scale formatting." } } } ], "description": "The column used for the X-axis." }, "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Chart description (subtitle / tooltip text) plus optional styling." }, "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": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend position. Default 'auto'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "colorLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the color legend when both color and size legends apply." }, "sizeLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the size legend when a size channel is present." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, position, and label styling." }, "tooltip": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." }, "multiSeries": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the tooltip lists multiple series. Only supported on bar, line, and area charts." }, "valueFormat": { "oneOf": [ { "type": "string", "enum": [ "percent" ] }, { "type": "string", "enum": [ "number" ] } ], "description": "Tooltip value format. Omit when the chart default applies." } }, "description": "Tooltip display options: column names, multiple series, and percent formatting." }, "stacking": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "stacked" ] }, { "type": "string", "enum": [ "normalized" ] } ], "description": "Stacking mode: 'none' (side-by-side / overlapping), 'stacked' (default — values sum), or 'normalized' (stack scaled to 100%)." }, "orientation": { "type": "string", "enum": [ "horizontal" ], "description": "Bar orientation. Omit (the default) for vertical bars; set to 'horizontal' for horizontal bars." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: single hex, categorical column, or continuous gradient." }, "barStyle": { "type": "object", "properties": { "cornerRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Bar corner shape: 'square' (default), 'round', or 'pill'." } }, "description": "Bar corner shape: 'square' (default), 'round', or 'pill'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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": "Number of decimal places when labels include percentages." }, "showStroke": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "on" ] }, { "type": "string", "enum": [ "off" ] } ], "description": "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": "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 values and labels to show on total (aggregate) labels." }, "orient": { "oneOf": [ { "type": "string", "enum": [ "horizontal" ] }, { "type": "string", "enum": [ "vertical" ] } ], "description": "Text direction for total labels." } }, "description": "Options for aggregate total labels on 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": "Gap width between individual bars in a band (format panel: Gap width)." }, "betweenSets": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Gap between bar clusters when the chart is clustered (format panel: Gap between sets)." } }, "description": "Bar gap width and spacing 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": "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 chart." }, "backgroundImage": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported)." } }, "description": "Optional plot-area background image. Url supports dynamic-text {{formula}} references." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "refMarks": { "type": "array", "items": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type", "axis", "value" ], "properties": { "type": { "type": "string", "enum": [ "line" ], "description": "Reference line." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Position on the axis (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Line stroke styling." } } }, { "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] }, { "allOf": [ { "type": "object", "required": [ "type", "axis", "value", "endValue" ], "properties": { "type": { "type": "string", "enum": [ "band" ], "description": "Reference band." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band start position (constant, column aggregation, or formula)." }, "endValue": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "constant" ] } } }, { "type": "object", "properties": { "value": { "type": "number", "description": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band end position (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Band outline visibility. Set to 'shown' to draw the band border." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Band outline stroke styling." }, "fill": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Band fill color (hex or theme reference)." } }, "description": "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] } ] }, "description": "Reference lines and bands on the chart." }, "trellis": { "type": "object", "properties": { "column": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis column facet." }, "row": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis row facet." }, "share": { "type": "object", "properties": { "color-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share color legends across the trellis grid. Omit when 'shared' (default)." }, "size-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share size legends across panels. Omit when 'shared'. Scatter with a size channel only." }, "x-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the category-axis scale across panels (UI label follows chart orientation)." }, "y-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the series-axis scale across panels (UI label follows chart orientation)." }, "y-axis-2": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the second series-axis scale. Combo charts with a second value axis only." } }, "description": "Shared scales and legends across trellis panels." }, "tileSize": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "compact" ] } ], "description": "Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series." } }, "description": "Trellis tile size, row/column facet styling, and shared scales/legends." }, "trendlines": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "columnId", "model" ], "properties": { "columnId": { "type": "string", "description": "Series column id (Y-axis) 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 matching the format panel: linear, quadratic, polynomial, exponential, logarithmic, or power." } } }, { "type": "object", "properties": { "degree": { "type": "number", "description": "Polynomial degree (3–7). Required when model is 'polynomial'." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Trend line stroke styling." }, "label": { "allOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } } }, { "type": "object", "properties": { "text": { "type": "string", "description": "Custom label text." } } } ], "description": "Custom label. Omit the block to hide the label." }, "value": { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } }, "description": "Regression fit value (R²). Omit the block to hide the value." }, "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 value annotation position." }, "fontSize": { "type": "number", "description": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and value annotations." } } } ] }, "description": "Regression trend lines on the chart." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the chart." }, "color": { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order." } } } ], "description": "The column for the categorical split (slice labels)." }, "value": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } }, "description": "The column for the slice size." } } }, { "type": "object", "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Chart description (subtitle / tooltip text) plus optional styling." }, "dataLabel": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex 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": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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": "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": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend position. Default 'auto'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "colorLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the color legend when both color and size legends apply." }, "sizeLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the size legend when a size channel is present." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, position, and label styling." }, "tooltip": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." }, "multiSeries": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the tooltip lists multiple series. Only supported on bar, line, and area charts." }, "valueFormat": { "oneOf": [ { "type": "string", "enum": [ "percent" ] }, { "type": "string", "enum": [ "number" ] } ], "description": "Tooltip value format. Omit when the chart default applies." } }, "description": "Tooltip display options: column names, multiple series, and percent formatting." }, "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 chart." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the chart." }, "color": { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order." } } } ], "description": "The column for the categorical split (slice labels)." }, "value": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } }, "description": "The column for the slice size." } } }, { "type": "object", "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Chart description (subtitle / tooltip text) plus optional styling." }, "dataLabel": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex 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": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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": "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": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend position. Default 'auto'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "colorLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the color legend when both color and size legends apply." }, "sizeLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the size legend when a size channel is present." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, position, and label styling." }, "tooltip": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." }, "multiSeries": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the tooltip lists multiple series. Only supported on bar, line, and area charts." }, "valueFormat": { "oneOf": [ { "type": "string", "enum": [ "percent" ] }, { "type": "string", "enum": [ "number" ] } ], "description": "Tooltip value format. Omit when the chart default applies." } }, "description": "Tooltip display options: column names, multiple series, and percent formatting." }, "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 chart." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "Actions triggered by interacting with this element." }, "holeValue": { "type": "object", "required": [ "id" ], "properties": { "id": { "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": "Hole value visibility. Omit when shown (default)." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Hole value font size in pixels." } } }, "title": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Hole title visibility. Omit when shown (default)." }, "text": { "type": "string", "description": "Hole title text." }, "wrap": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Text wrap: 'shown' to wrap, 'hidden' for single line." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Hole title font size in pixels." }, "position": { "oneOf": [ { "type": "string", "enum": [ "top" ] }, { "type": "string", "enum": [ "bottom" ] } ], "description": "Donut hole title position: 'top' or 'bottom'." } } } }, "description": "Donut hole center title and value styling." }, "innerRadius": { "type": "number", "description": "Donut hole size as a ratio of the outer radius (typically 0.4–0.8). Omit when default (0.6)." }, "trellis": { "type": "object", "properties": { "column": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis column facet." }, "row": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis row facet." }, "share": { "type": "object", "properties": { "color-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share color legends across the trellis grid. Omit when 'shared' (default)." }, "size-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share size legends across panels. Omit when 'shared'. Scatter with a size channel only." }, "x-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the category-axis scale across panels (UI label follows chart orientation)." }, "y-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the series-axis scale across panels (UI label follows chart orientation)." }, "y-axis-2": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the second series-axis scale. Combo charts with a second value axis only." } }, "description": "Shared scales and legends across trellis panels." }, "tileSize": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "compact" ] } ], "description": "Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series." } }, "description": "Trellis tile size, row/column facet styling, and shared scales/legends." } } } ] } ], "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the line chart." }, "yAxis": { "allOf": [ { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "oneOf": [ { "type": "string", "description": "Column ID for a Y-axis series." }, { "allOf": [ { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column ID for a Y-axis series." } } }, { "type": "object", "properties": { "type": { "oneOf": [ { "type": "string", "enum": [ "bar" ] }, { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "scatter" ] } ], "description": "Per-series chart shape: 'bar' (default), 'line', 'area', or 'scatter'." } } } ] } ] }, "description": "Column IDs for the Y-axis series." } } }, { "type": "object", "properties": { "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "Y-axis title, labels, marks, and scale formatting." } } } ], "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order." }, "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "X-axis title, labels, marks, and scale formatting." } } } ], "description": "The column used for the X-axis." }, "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Chart description (subtitle / tooltip text) plus optional styling." }, "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": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend position. Default 'auto'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "colorLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the color legend when both color and size legends apply." }, "sizeLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the size legend when a size channel is present." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, position, and label styling." }, "tooltip": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." }, "multiSeries": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the tooltip lists multiple series. Only supported on bar, line, and area charts." }, "valueFormat": { "oneOf": [ { "type": "string", "enum": [ "percent" ] }, { "type": "string", "enum": [ "number" ] } ], "description": "Tooltip value format. Omit when the chart default applies." } }, "description": "Tooltip display options: column names, multiple series, and percent formatting." }, "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 chart." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: 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." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Area outline visibility. Omit when shown; only 'hidden' is emitted on read. Not valid on line-chart." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 (on area charts) area outline visibility." }, "points": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Point markers. Omit when shown; only 'hidden' is emitted on read." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } }, "description": "Point markers on the series." } }, "description": "Line interpolation, stroke, point markers, and null handling for the series." }, "backgroundImage": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported)." } }, "description": "Optional plot-area background image. Url supports dynamic-text {{formula}} references." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "refMarks": { "type": "array", "items": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type", "axis", "value" ], "properties": { "type": { "type": "string", "enum": [ "line" ], "description": "Reference line." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Position on the axis (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Line stroke styling." } } }, { "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] }, { "allOf": [ { "type": "object", "required": [ "type", "axis", "value", "endValue" ], "properties": { "type": { "type": "string", "enum": [ "band" ], "description": "Reference band." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band start position (constant, column aggregation, or formula)." }, "endValue": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "constant" ] } } }, { "type": "object", "properties": { "value": { "type": "number", "description": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band end position (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Band outline visibility. Set to 'shown' to draw the band border." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Band outline stroke styling." }, "fill": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Band fill color (hex or theme reference)." } }, "description": "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] } ] }, "description": "Reference lines and bands on the chart." }, "trellis": { "type": "object", "properties": { "column": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis column facet." }, "row": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis row facet." }, "share": { "type": "object", "properties": { "color-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share color legends across the trellis grid. Omit when 'shared' (default)." }, "size-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share size legends across panels. Omit when 'shared'. Scatter with a size channel only." }, "x-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the category-axis scale across panels (UI label follows chart orientation)." }, "y-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the series-axis scale across panels (UI label follows chart orientation)." }, "y-axis-2": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the second series-axis scale. Combo charts with a second value axis only." } }, "description": "Shared scales and legends across trellis panels." }, "tileSize": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "compact" ] } ], "description": "Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series." } }, "description": "Trellis tile size, row/column facet styling, and shared scales/legends." }, "trendlines": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "columnId", "model" ], "properties": { "columnId": { "type": "string", "description": "Series column id (Y-axis) 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 matching the format panel: linear, quadratic, polynomial, exponential, logarithmic, or power." } } }, { "type": "object", "properties": { "degree": { "type": "number", "description": "Polynomial degree (3–7). Required when model is 'polynomial'." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Trend line stroke styling." }, "label": { "allOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } } }, { "type": "object", "properties": { "text": { "type": "string", "description": "Custom label text." } } } ], "description": "Custom label. Omit the block to hide the label." }, "value": { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } }, "description": "Regression fit value (R²). Omit the block to hide the value." }, "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 value annotation position." }, "fontSize": { "type": "number", "description": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and value annotations." } } } ] }, "description": "Regression trend lines on the chart." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the area chart." }, "yAxis": { "allOf": [ { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "oneOf": [ { "type": "string", "description": "Column ID for a Y-axis series." }, { "allOf": [ { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column ID for a Y-axis series." } } }, { "type": "object", "properties": { "type": { "oneOf": [ { "type": "string", "enum": [ "bar" ] }, { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "scatter" ] } ], "description": "Per-series chart shape: 'bar' (default), 'line', 'area', or 'scatter'." } } } ] } ] }, "description": "Column IDs for the Y-axis series." } } }, { "type": "object", "properties": { "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "Y-axis title, labels, marks, and scale formatting." } } } ], "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order." }, "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "X-axis title, labels, marks, and scale formatting." } } } ], "description": "The column used for the X-axis." }, "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Chart description (subtitle / tooltip text) plus optional styling." }, "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": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend position. Default 'auto'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "colorLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the color legend when both color and size legends apply." }, "sizeLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the size legend when a size channel is present." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, position, and label styling." }, "tooltip": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." }, "multiSeries": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the tooltip lists multiple series. Only supported on bar, line, and area charts." }, "valueFormat": { "oneOf": [ { "type": "string", "enum": [ "percent" ] }, { "type": "string", "enum": [ "number" ] } ], "description": "Tooltip value format. Omit when the chart default applies." } }, "description": "Tooltip display options: column names, multiple series, and percent formatting." }, "stacking": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "stacked" ] }, { "type": "string", "enum": [ "normalized" ] } ], "description": "Stacking mode: 'none' (side-by-side / overlapping), 'stacked' (default — values sum), or 'normalized' (stack scaled to 100%)." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: 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." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Area outline visibility. Omit when shown; only 'hidden' is emitted on read. Not valid on line-chart." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 (on area charts) area outline visibility." }, "points": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Point markers. Omit when shown; only 'hidden' is emitted on read." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } }, "description": "Point markers on the series." } }, "description": "Interpolation, area outline, stroke, point markers, 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": "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 chart." }, "backgroundImage": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported)." } }, "description": "Optional plot-area background image. Url supports dynamic-text {{formula}} references." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "trellis": { "type": "object", "properties": { "column": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis column facet." }, "row": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis row facet." }, "share": { "type": "object", "properties": { "color-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share color legends across the trellis grid. Omit when 'shared' (default)." }, "size-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share size legends across panels. Omit when 'shared'. Scatter with a size channel only." }, "x-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the category-axis scale across panels (UI label follows chart orientation)." }, "y-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the series-axis scale across panels (UI label follows chart orientation)." }, "y-axis-2": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the second series-axis scale. Combo charts with a second value axis only." } }, "description": "Shared scales and legends across trellis panels." }, "tileSize": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "compact" ] } ], "description": "Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series." } }, "description": "Trellis tile size, row/column facet styling, and shared scales/legends." }, "trendlines": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "columnId", "model" ], "properties": { "columnId": { "type": "string", "description": "Series column id (Y-axis) 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 matching the format panel: linear, quadratic, polynomial, exponential, logarithmic, or power." } } }, { "type": "object", "properties": { "degree": { "type": "number", "description": "Polynomial degree (3–7). Required when model is 'polynomial'." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Trend line stroke styling." }, "label": { "allOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } } }, { "type": "object", "properties": { "text": { "type": "string", "description": "Custom label text." } } } ], "description": "Custom label. Omit the block to hide the label." }, "value": { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } }, "description": "Regression fit value (R²). Omit the block to hide the value." }, "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 value annotation position." }, "fontSize": { "type": "number", "description": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and value annotations." } } } ] }, "description": "Regression trend lines on the chart." }, "refMarks": { "type": "array", "items": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type", "axis", "value" ], "properties": { "type": { "type": "string", "enum": [ "line" ], "description": "Reference line." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Position on the axis (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Line stroke styling." } } }, { "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] }, { "allOf": [ { "type": "object", "required": [ "type", "axis", "value", "endValue" ], "properties": { "type": { "type": "string", "enum": [ "band" ], "description": "Reference band." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band start position (constant, column aggregation, or formula)." }, "endValue": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "constant" ] } } }, { "type": "object", "properties": { "value": { "type": "number", "description": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band end position (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Band outline visibility. Set to 'shown' to draw the band border." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Band outline stroke styling." }, "fill": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Band fill color (hex or theme reference)." } }, "description": "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] } ] }, "description": "Reference lines and bands on the chart." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the scatter chart." }, "yAxis": { "allOf": [ { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "oneOf": [ { "type": "string", "description": "Column ID for a Y-axis series." }, { "allOf": [ { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column ID for a Y-axis series." } } }, { "type": "object", "properties": { "type": { "oneOf": [ { "type": "string", "enum": [ "bar" ] }, { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "scatter" ] } ], "description": "Per-series chart shape: 'bar' (default), 'line', 'area', or 'scatter'." } } } ] } ] }, "description": "Column IDs for the Y-axis series." } } }, { "type": "object", "properties": { "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "Y-axis title, labels, marks, and scale formatting." } } } ], "description": "The columns used for the Y-axis. Most scatter plots have one Y-axis column; multiple turn on a series-per-column scatter." } } }, { "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order." }, "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "X-axis title, labels, marks, and scale formatting." } } } ], "description": "The column used for the X-axis." }, "size": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } }, "description": "Optional column whose values drive the bubble size." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: single hex, categorical column, or continuous gradient." }, "dataLabel": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether values appear on chart marks." }, "precision": { "type": "number", "description": "Number of decimal places when labels use percent format." }, "showStroke": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "on" ] }, { "type": "string", "enum": [ "off" ] } ], "description": "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" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Chart description (subtitle / tooltip text) plus optional styling." }, "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": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend position. Default 'auto'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "colorLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the color legend when both color and size legends apply." }, "sizeLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the size legend when a size channel is present." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, position, and label styling." }, "tooltip": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." }, "multiSeries": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the tooltip lists multiple series. Only supported on bar, line, and area charts." }, "valueFormat": { "oneOf": [ { "type": "string", "enum": [ "percent" ] }, { "type": "string", "enum": [ "number" ] } ], "description": "Tooltip value format. Omit when the chart default applies." } }, "description": "Tooltip display options: column names, multiple series, and percent formatting." }, "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 chart." }, "backgroundImage": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported)." } }, "description": "Optional plot-area background image. Url supports dynamic-text {{formula}} references." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "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": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." }, { "oneOf": [ { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Point size preset when a size channel is bound. Maps to store area values (Small/Medium/Large in the format panel)." } ] } }, "description": "Point marker shape and size for the format-panel Point style section." }, "refMarks": { "type": "array", "items": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type", "axis", "value" ], "properties": { "type": { "type": "string", "enum": [ "line" ], "description": "Reference line." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Position on the axis (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Line stroke styling." } } }, { "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] }, { "allOf": [ { "type": "object", "required": [ "type", "axis", "value", "endValue" ], "properties": { "type": { "type": "string", "enum": [ "band" ], "description": "Reference band." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band start position (constant, column aggregation, or formula)." }, "endValue": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "constant" ] } } }, { "type": "object", "properties": { "value": { "type": "number", "description": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band end position (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Band outline visibility. Set to 'shown' to draw the band border." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Band outline stroke styling." }, "fill": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Band fill color (hex or theme reference)." } }, "description": "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] } ] }, "description": "Reference lines and bands on the chart." }, "trellis": { "type": "object", "properties": { "column": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis column facet." }, "row": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis row facet." }, "share": { "type": "object", "properties": { "color-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share color legends across the trellis grid. Omit when 'shared' (default)." }, "size-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share size legends across panels. Omit when 'shared'. Scatter with a size channel only." }, "x-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the category-axis scale across panels (UI label follows chart orientation)." }, "y-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the series-axis scale across panels (UI label follows chart orientation)." }, "y-axis-2": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the second series-axis scale. Combo charts with a second value axis only." } }, "description": "Shared scales and legends across trellis panels." }, "tileSize": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "compact" ] } ], "description": "Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series." } }, "description": "Trellis tile size, row/column facet styling, and shared scales/legends." }, "trendlines": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "columnId", "model" ], "properties": { "columnId": { "type": "string", "description": "Series column id (Y-axis) 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 matching the format panel: linear, quadratic, polynomial, exponential, logarithmic, or power." } } }, { "type": "object", "properties": { "degree": { "type": "number", "description": "Polynomial degree (3–7). Required when model is 'polynomial'." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Trend line stroke styling." }, "label": { "allOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } } }, { "type": "object", "properties": { "text": { "type": "string", "description": "Custom label text." } } } ], "description": "Custom label. Omit the block to hide the label." }, "value": { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } }, "description": "Regression fit value (R²). Omit the block to hide the value." }, "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 value annotation position." }, "fontSize": { "type": "number", "description": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and value annotations." } } } ] }, "description": "Regression trend lines on the chart." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the combo chart." }, "yAxis": { "allOf": [ { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "oneOf": [ { "type": "string", "description": "Column ID for a Y-axis series." }, { "allOf": [ { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Column ID for a Y-axis series." } } }, { "type": "object", "properties": { "type": { "oneOf": [ { "type": "string", "enum": [ "bar" ] }, { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "area" ] }, { "type": "string", "enum": [ "scatter" ] } ], "description": "Per-series chart shape: 'bar' (default), 'line', 'area', or 'scatter'." } } } ] } ] }, "description": "Column IDs for the Y-axis series." } } }, { "type": "object", "properties": { "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "Y-axis title, labels, marks, and scale formatting." } } } ], "description": "The columns used for the Y-axis. Each entry can specify its own `type` (bar / line / area / scatter); default is bar." } } }, { "type": "object", "properties": { "yAxis2": { "allOf": [ { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "type": "string", "description": "Column ID for a series assigned to Y-axis 2." }, "description": "Column IDs for series on the secondary Y-axis." } } }, { "type": "object", "properties": { "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "Y-axis 2 title, labels, marks, scale, and tick spacing." } } } ], "description": "Secondary Y-axis: series assignment (`columnIds`) and axis formatting (`format`). Combo only." }, "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order." }, "format": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the axis. No other fields on this branch." } } }, { "type": "object", "properties": { "title": { "type": "object", "properties": { "text": { "type": "string", "description": "Axis title text." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." } } }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "object", "properties": { "labelAngle": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Label angle in degrees, or 'auto'." }, "fontSize": { "oneOf": [ { "type": "number" }, { "type": "string", "enum": [ "auto" ] } ], "description": "Font size in pixels, or 'auto' to let the viz pick." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "allowLongerLabels": { "type": "boolean", "description": "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": "Axis marks: 'none', 'tick', 'grid', 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": "Axis scale type." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." } } }, "zero": { "type": "boolean", "description": "Always include zero in the axis domain." }, "reverse": { "type": "boolean", "description": "Reverse the axis direction." }, "hideZeroLine": { "type": "boolean", "description": "Hide the zero guideline on the axis." } } }, "tickSpacing": { "oneOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "auto" ], "description": "Automatic axis mark spacing." } } }, { "type": "object", "required": [ "type", "count" ], "properties": { "type": { "type": "string", "enum": [ "count" ], "description": "Target tick count spacing." }, "count": { "type": "number", "description": "Approximate number of axis marks (1–30 in the UI)." } } }, { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "unit": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the time interval unit." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "unit" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "time" ], "description": "Interval mode for a time scale." }, "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": "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 anchor, or null." }, "minor": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Hide minor axis marks. No other fields on this branch." } } }, { "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": "Minor tick time unit." }, "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] }, { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "string", "enum": [ "auto" ], "description": "Let the viz pick the numeric step." } } }, { "allOf": [ { "type": "object", "required": [ "type", "scale", "step" ], "properties": { "type": { "type": "string", "enum": [ "interval" ], "description": "Fixed interval spacing." }, "scale": { "type": "string", "enum": [ "linear" ], "description": "Interval mode for a linear scale." }, "step": { "type": "number", "description": "Step in axis data units (same units as the linear scale domain)." } } }, { "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": "Hide minor axis marks. No other fields on this branch." } } }, { "type": "object", "required": [ "step", "mark" ], "properties": { "step": { "type": "number", "description": "Minor tick step size." }, "mark": { "oneOf": [ { "type": "string", "enum": [ "tick" ] }, { "type": "string", "enum": [ "grid" ] }, { "type": "string", "enum": [ "both" ] } ], "description": "Minor axis mark style: 'tick', 'grid', or 'both'." } } } ] } } } ] } ] } } } ], "description": "X-axis title, labels, marks, and scale formatting." } } } ], "description": "The column used for the X-axis." }, "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Chart description (subtitle / tooltip text) plus optional styling." }, "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": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend position. Default 'auto'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "colorLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the color legend when both color and size legends apply." }, "sizeLegend": { "type": "string", "enum": [ "hidden" ], "description": "Hide the size legend when a size channel is present." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, position, and label styling." }, "tooltip": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." }, "multiSeries": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the tooltip lists multiple series. Only supported on bar, line, and area charts." }, "valueFormat": { "oneOf": [ { "type": "string", "enum": [ "percent" ] }, { "type": "string", "enum": [ "number" ] } ], "description": "Tooltip value format. Omit when the chart default applies." } }, "description": "Tooltip display options: column names, multiple series, and percent formatting." }, "stacking": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "stacked" ] }, { "type": "string", "enum": [ "normalized" ] } ], "description": "Stacking mode: 'none' (side-by-side / overlapping), 'stacked' (default — values sum), or 'normalized' (stack scaled to 100%)." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: single hex, categorical column, or continuous gradient." }, "barStyle": { "type": "object", "properties": { "cornerRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Bar corner shape: 'square' (default), 'round', or 'pill'." } }, "description": "Bar corner shape for bar layers: 'square' (default), 'round', or 'pill'." }, "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." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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": "Number of decimal places when labels include percentages." }, "showStroke": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "on" ] }, { "type": "string", "enum": [ "off" ] } ], "description": "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": "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 values and labels to show on total (aggregate) labels." }, "orient": { "oneOf": [ { "type": "string", "enum": [ "horizontal" ] }, { "type": "string", "enum": [ "vertical" ] } ], "description": "Text direction for total labels." } }, "description": "Options for aggregate total labels when the combo includes bar layers." }, "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. Layer-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": "Gap width between individual bars in a band (format panel: Gap width)." }, "betweenSets": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Gap between bar clusters when the chart is clustered (format panel: Gap between sets)." } }, "description": "Bar gap width and spacing between clustered bar sets on combo bar layers." }, "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 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." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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 area layer labels." }, "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": "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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": "Number of decimal places when labels include percentages." }, "showStroke": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "on" ] }, { "type": "string", "enum": [ "off" ] } ], "description": "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": "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 values and labels to show on total (aggregate) labels." }, "orient": { "oneOf": [ { "type": "string", "enum": [ "horizontal" ] }, { "type": "string", "enum": [ "vertical" ] } ], "description": "Text direction for total labels." } }, "description": "Options for aggregate total labels on 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." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "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 line layer labels." }, "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": "Outline around data labels." } } }, "scatter": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Color used for data label text (hex or theme reference)." }, "fontSize": { "type": "number", "description": "Font size for data labels, in pixels." }, "fontWeight": { "type": "number", "description": "Font weight for data labels (for example, regular or semibold)." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether values appear on chart marks." }, "precision": { "type": "number", "description": "Number of decimal places when labels use percent format." }, "showStroke": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "on" ] }, { "type": "string", "enum": [ "off" ] } ], "description": "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 settings grouped by layer: 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": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." }, { "oneOf": [ { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Point size preset when a size channel is bound. Maps to store area values (Small/Medium/Large in the format panel)." } ] } }, "description": "Default point marker shape and size for scatter layers." }, "seriesPointStyle": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "columnId" ], "properties": { "columnId": { "type": "string", "description": "Y-axis column id for a combo scatter layer." } } }, { "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": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." }, { "oneOf": [ { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Point size preset when a size channel is bound. Maps to store area values (Small/Medium/Large in the format panel)." } ] } } } ] }, "description": "Per-series point style overrides on combo charts (scatter layers only). Each entry lists only fields that differ from `pointStyle`." }, "backgroundImage": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the plot background image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported)." } }, "description": "Optional plot-area background image. Url supports dynamic-text {{formula}} references." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Area outline visibility. Omit when shown; only 'hidden' is emitted on read. Not valid on line-chart." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 (on area charts) area outline visibility." }, "points": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Point markers. Omit when shown; only 'hidden' is emitted on read." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } }, "description": "Point markers on the series." } }, "description": "Default line/area layer interpolation, stroke, points, and null handling." }, "seriesLineAreaStyle": { "type": "object", "additionalProperties": { "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Area outline visibility. Omit when shown; only 'hidden' is emitted on read. Not valid on line-chart." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 (on area charts) area outline visibility." }, "points": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Point markers. Omit when shown; only 'hidden' is emitted on read." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } }, "description": "Point markers on the series." } } }, "description": "Per-series line/area style overrides on combo charts (Y-axis column id keys)." }, "refMarks": { "type": "array", "items": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type", "axis", "value" ], "properties": { "type": { "type": "string", "enum": [ "line" ], "description": "Reference line." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Position on the axis (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Line stroke styling." } } }, { "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] }, { "allOf": [ { "type": "object", "required": [ "type", "axis", "value", "endValue" ], "properties": { "type": { "type": "string", "enum": [ "band" ], "description": "Reference band." }, "axis": { "oneOf": [ { "type": "string", "enum": [ "axis" ] }, { "type": "string", "enum": [ "series" ] }, { "type": "string", "enum": [ "series2" ] } ], "description": "Axis channel: primary axis ('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": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band start position (constant, column aggregation, or formula)." }, "endValue": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "constant" ] } } }, { "type": "object", "properties": { "value": { "type": "number", "description": "Constant position on the axis. Omit when unset." } } } ] }, { "type": "object", "required": [ "type", "columnId", "func" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "columnId": { "type": "string", "description": "Column id for the aggregation." }, "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": "Sling formula returning a number or datetime for the mark position." } } } ], "description": "Band end position (constant, column aggregation, or formula)." } } }, { "type": "object", "properties": { "line": { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Band outline visibility. Set to 'shown' to draw the band border." }, "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Line color (hex or theme reference)." } }, "description": "Band outline stroke styling." }, "fill": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Band fill color (hex or theme reference)." } }, "description": "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": "Custom label text." } } } ], "description": "Custom label. Omit the block 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": "Computed value label. Omit the block to hide the value (not the mark `value` field)." }, "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": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and annotation." }, "scope": { "oneOf": [ { "type": "string", "enum": [ "chart" ] }, { "type": "string", "enum": [ "cell" ] } ], "description": "Trellis scope: 'chart' (shared) or 'cell' (per panel). Omit for the default shared scope." } } } ] } ] }, "description": "Reference lines and bands on the chart." }, "trellis": { "type": "object", "properties": { "column": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis column facet." }, "row": { "type": "object", "properties": { "border": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the row/column border." }, "labels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Label color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet labels: 'hidden' or styling overrides." }, "title": { "oneOf": [ { "type": "string", "enum": [ "hidden" ], "description": "Hide this guide component." }, { "type": "object", "properties": { "text": { "type": "string", "description": "Trellis title text." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "color": { "oneOf": [ { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } }, { "type": "string" } ], "description": "Title color: hex or `{ kind: theme, ref }`." } } } ], "description": "Facet title: 'hidden', or text and styling overrides." } }, "description": "Format for the trellis row facet." }, "share": { "type": "object", "properties": { "color-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share color legends across the trellis grid. Omit when 'shared' (default)." }, "size-legends": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share size legends across panels. Omit when 'shared'. Scatter with a size channel only." }, "x-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the category-axis scale across panels (UI label follows chart orientation)." }, "y-axis": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the series-axis scale across panels (UI label follows chart orientation)." }, "y-axis-2": { "oneOf": [ { "type": "string", "enum": [ "shared" ] }, { "type": "string", "enum": [ "separate" ] } ], "description": "Share the second series-axis scale. Combo charts with a second value axis only." } }, "description": "Shared scales and legends across trellis panels." }, "tileSize": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "compact" ] } ], "description": "Trellis tile size. Default 'auto' for category trellis, 'compact' for trellis by series." } }, "description": "Trellis tile size, row/column facet styling, and shared scales/legends." }, "trendlines": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "columnId", "model" ], "properties": { "columnId": { "type": "string", "description": "Series column id (Y-axis) 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 matching the format panel: linear, quadratic, polynomial, exponential, logarithmic, or power." } } }, { "type": "object", "properties": { "degree": { "type": "number", "description": "Polynomial degree (3–7). Required when model is 'polynomial'." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Line type: 'solid', 'dashed', or 'dotted'." }, "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": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Trend line stroke styling." }, "label": { "allOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } } }, { "type": "object", "properties": { "text": { "type": "string", "description": "Custom label text." } } } ], "description": "Custom label. Omit the block to hide the label." }, "value": { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Annotation is shown. Omit the `label` or `value` block entirely to hide it." } }, "description": "Regression fit value (R²). Omit the block to hide the value." }, "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 value annotation position." }, "fontSize": { "type": "number", "description": "Annotation font size in pixels (same control as in the format panel)." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } }, "description": "Shared placement and typography for label and value annotations." } } } ] }, "description": "Regression trend lines on the chart." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "Actions triggered by interacting with this element." } } } ], "description": "", "title": "Combo 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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the point map." }, "latitude": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } }, "description": "The column whose values are point latitudes (degrees, WGS84)." }, "longitude": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } }, "description": "The column whose values are point longitudes (degrees, WGS84)." } } }, { "type": "object", "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`. Maps do not support alignment." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Map description (subtitle / tooltip text) plus optional styling." }, "legend": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend corner position on maps." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, corner 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": "Allow pan and zoom on the map. Omit when shown (default)." } } }, { "type": "object", "required": [ "baseStyle", "styleUrl" ], "properties": { "baseStyle": { "type": "string", "enum": [ "custom" ], "description": "Custom Mapbox style; requires `styleUrl`." }, "styleUrl": { "type": "string", "description": "Mapbox style URL. Required when `baseStyle` is `custom`." } } } ] }, { "type": "object" }, { "oneOf": [ { "type": "object" }, { "type": "object" }, { "type": "object" } ] } ] }, { "type": "null" } ], "description": "Map style: base style, custom URL, allow pan/zoom, and 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": "Min and max point diameters in pixels when a size channel is bound. Omit when default [3, 15]." } ] } } }, { "type": "null" } ], "description": "Point mark opacity and size for the format-panel Point style section." }, "size": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } }, "description": "Optional column whose values drive the bubble size." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: single hex, categorical column, or continuous gradient." }, "label": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } } }, "description": "Optional columns rendered as text labels next to each point." }, "tooltip": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } } }, "description": "Optional columns shown in the hover tooltip." }, "tooltipFormat": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." } }, "description": "Tooltip display options. Maps use `tooltip` for hover column refs; use `tooltipFormat` for format-panel settings." }, "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 chart." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the region map." }, "region": { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "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": "Which kind of region the column represents (country, us-state, etc.). Sets the column's geo-region semantic role." } } } ], "description": "The region column and the kind of region it contains." } } }, { "type": "object", "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`. Maps do not support alignment." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Map description (subtitle / tooltip text) plus optional styling." }, "legend": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend corner position on maps." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, corner 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": "Allow pan and zoom on the map. Omit when shown (default)." } } }, { "type": "object", "required": [ "baseStyle", "styleUrl" ], "properties": { "baseStyle": { "type": "string", "enum": [ "custom" ], "description": "Custom Mapbox style; requires `styleUrl`." }, "styleUrl": { "type": "string", "description": "Mapbox style URL. Required when `baseStyle` is `custom`." } } } ] }, { "type": "object" }, { "oneOf": [ { "type": "object" }, { "type": "object" }, { "type": "object" } ] } ] }, { "type": "null" } ], "description": "Map style: base style, custom URL, allow pan/zoom, and 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": "Region fill opacity for the format-panel Region style section." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: single hex, categorical column, or continuous gradient." }, "label": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } } }, "description": "Optional columns rendered as text labels on each region." }, "tooltip": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } } }, "description": "Optional columns shown in the hover tooltip." }, "tooltipFormat": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." } }, "description": "Tooltip display options. Maps use `tooltip` for hover column refs; use `tooltipFormat` for format-panel settings." }, "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 chart." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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." }, "kind": { "type": "string", "enum": [ "geography-map" ] }, "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 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 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "description": "The columns used by the geography map." }, "geography": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } }, "description": "The column whose values are GeoJSON geometries (Point, Polygon, MultiPolygon, LineString, etc.)." } } }, { "type": "object", "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`. Maps do not support alignment." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Map description (subtitle / tooltip text) plus optional styling." }, "legend": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to hide the legend. No other fields on this branch." } } }, { "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": "Legend corner position on maps." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Legend label font size in pixels." }, "header": { "type": "string", "enum": [ "hidden" ], "description": "Hide the legend header row." } } } ], "description": "Legend visibility, corner 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": "Allow pan and zoom on the map. Omit when shown (default)." } } }, { "type": "object", "required": [ "baseStyle", "styleUrl" ], "properties": { "baseStyle": { "type": "string", "enum": [ "custom" ], "description": "Custom Mapbox style; requires `styleUrl`." }, "styleUrl": { "type": "string", "description": "Mapbox style URL. Required when `baseStyle` is `custom`." } } } ] }, { "type": "object" }, { "oneOf": [ { "type": "object" }, { "type": "object" }, { "type": "object" } ] } ] }, { "type": "null" } ], "description": "Map style: base style, custom URL, allow pan/zoom, and 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": "Feature mark opacity and point size for the format-panel Feature style section." }, "color": { "oneOf": [ { "type": "object", "required": [ "by", "value" ], "properties": { "by": { "type": "string", "enum": [ "single" ] }, "value": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." } } }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "category" ] }, "column": { "type": "string", "description": "Column id whose values drive the categorical color assignment." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." } } } ] }, { "allOf": [ { "type": "object", "required": [ "by", "column" ], "properties": { "by": { "type": "string", "enum": [ "scale" ] }, "column": { "type": "string", "description": "Numeric column id whose values drive the continuous color gradient." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops defining the palette / gradient." }, "domain": { "type": "object", "properties": { "min": { "type": "number", "description": "Continuous-scale domain minimum." }, "max": { "type": "number", "description": "Continuous-scale domain maximum." }, "mid": { "type": "number", "description": "Continuous-scale midpoint. Presence selects a diverging gradient; absence is sequential." } } } } } ] } ], "description": "Color configuration: single hex, categorical column, or continuous gradient." }, "tooltip": { "type": "array", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The column ID." } } }, "description": "Optional columns shown in the hover tooltip." }, "tooltipFormat": { "type": "object", "properties": { "columnNames": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether column names appear in the tooltip." } }, "description": "Tooltip display options. Maps use `tooltip` for hover column refs; use `tooltipFormat` for format-panel settings." }, "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 chart." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "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": [ { "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", "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" }, { "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" }, { "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" }, { "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" }, { "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" }, { "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 data source for the pivot 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." } } }, { "type": "object", "properties": { "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Sparkline mark formatting for sparkline-type columns." } } } ] }, "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" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display name. A bare string for text-only, an object `{ text, ...styling }` for font size, color, alignment, or weight, or `{ visibility: 'hidden' }` to hide the title. Supports embedded {{formula}} interpolation in `text`." }, "description": { "type": "object", "properties": { "visibility": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } }, "description": "Pivot description (subtitle / tooltip text) plus optional styling." }, "noDataText": { "type": "string", "description": "Custom message rendered when the chart has no data." }, "rowsBy": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order for this shelf entry." } } } ] }, "description": "Column IDs placed on the row shelf." }, "columnsBy": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "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": "Sort direction." } } }, { "type": "object", "properties": { "by": { "type": "string", "description": "Column ID to sort by, or \"row-count\" to sort by number of rows. If omitted, sorts by the column values themselves." }, "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 custom sort. Only valid when \"by\" references a column ID (not \"row-count\")." } } } ], "description": "Sort order for this shelf entry." } } } ] }, "description": "Column IDs placed on the column shelf." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "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": "A Sling formula returning a boolean. The formula may reference any column on the sheet, not just the styled columns." } } } ] }, { "type": "object", "properties": { "style": { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Cell background color (hex)." }, "color": { "type": "string", "description": "Font color (hex)." }, "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 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": "Number or datetime format override for the displayed value." } } } } } ] }, { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "backgroundScale" ] } } }, { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "type": "string" }, "description": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "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": "Apply this formatting to data cells. Defaults to true at render." }, "includeSubtotals": { "type": "boolean", "description": "Apply this formatting to subtotal rows. Defaults to false." }, "includeGrandTotals": { "type": "boolean", "description": "Apply this formatting to grand total rows. Defaults to false." } } } ] }, "description": "Conditional formatting applied to value cells of this pivot. Order matters: later entries apply on top of earlier ones." }, "tableStyle": { "type": "object", "properties": { "preset": { "oneOf": [ { "type": "string", "enum": [ "spreadsheet" ] }, { "type": "string", "enum": [ "presentation" ] } ], "description": "Table preset: 'spreadsheet' or 'presentation'. Omit when spreadsheet (default)." }, "cellSpacing": { "oneOf": [ { "type": "string", "enum": [ "extra-small" ] }, { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Cell spacing preset: 'extra-small', 'small', 'medium', or 'large'." }, "gridLines": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "vertical" ] }, { "type": "string", "enum": [ "horizontal" ] }, { "type": "string", "enum": [ "all" ] } ], "description": "Grid lines: 'none', 'vertical', 'horizontal', or 'all'." }, "banding": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Row banding visibility: 'shown' or 'hidden'." }, "bandingColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "autofitColumns": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Autofit column widths (level table only): 'shown' or 'hidden'." }, "outerBorder": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Outer table border: 'shown' or 'hidden'. Maps to inverted store `hideOuterBorder`." }, "headerDividerColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "heavyVerticalDividers": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Heavier vertical group dividers (pivot only): 'shown' or 'hidden'." }, "heavyHorizontalDividers": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Heavier horizontal group dividers (pivot only): 'shown' or 'hidden'." }, "textStyles": { "type": "object", "properties": { "header": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "cell": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "columnHeader": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "rowHeader": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } } } } }, "description": "Table style: grid preset, spacing, grid lines, banding, dividers, and per-tab text styles." }, "sparkline": { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "line" ] }, { "type": "string", "enum": [ "bar" ] } ], "description": "Sparkline geometry: 'line' or 'bar'. Omit when auto." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "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": "Line interpolation: linear, monotone, step, step-before, or step-after." }, "missing": { "oneOf": [ { "type": "string", "enum": [ "zero" ] }, { "type": "string", "enum": [ "interpolate" ] }, { "type": "string", "enum": [ "hide" ] } ], "description": "How null values are drawn between points." }, "line": { "type": "object", "properties": { "style": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: 'solid', 'dashed', or 'dotted'." }, "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 for line-shaped sparklines." }, "tooltip": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether the sparkline cell shows a hover tooltip." }, "points": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Point markers hidden. Must not include `shape` or `size`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Point markers shown. Omit on read when shown; may be set explicitly on write." }, "shape": { "oneOf": [ { "type": "string", "enum": [ "circle" ] }, { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "cross" ] }, { "type": "string", "enum": [ "diamond" ] }, { "type": "string", "enum": [ "triangle-up" ] } ], "description": "Point marker 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": "Point size by area scale (radius squared), when no size channel is bound." } } } ], "description": "Point markers on line sparklines." }, "labels": { "oneOf": [ { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Endpoint labels hidden. Must not include `color` or `fontSize`." } } }, { "type": "object", "properties": { "visibility": { "type": "string", "enum": [ "shown" ], "description": "Endpoint labels shown. Omit on read when shown; may be set explicitly on write." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Label font size in pixels." } } } ], "description": "Endpoint value labels on line sparklines." } }, "description": "Default sparkline mark formatting applied to all sparkline columns (Format tab apply-to-all)." }, "tableComponents": { "type": "object", "description": "Table component visibility toggles (column headers, row headers). Each key is `shown` or `hidden`; omit when shown (default)." }, "totals": { "type": "object", "properties": { "subTotalColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "subTotalBackgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "subTotalFontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "showSubtotals": { "oneOf": [ { "type": "string", "enum": [ "always" ] }, { "type": "string", "enum": [ "when-collapsed" ] } ], "description": "Subtotal default visibility: 'always' (default) or 'when-collapsed'." }, "grandTotalColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "grandTotalBackgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "grandTotalFontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "showGrandTotals": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ] }, "totalPosition": { "oneOf": [ { "type": "string", "enum": [ "first" ] }, { "type": "string", "enum": [ "last" ] } ], "description": "Total position: 'first' or 'last' (default)." } }, "description": "Pivot total row/column styling and default visibility (Format tab Totals section)." }, "display": { "type": "object", "properties": { "emptyCellDisplay": { "type": "string", "description": "Text shown in empty pivot value cells." }, "measureShelfPosition": { "type": "number", "description": "0-based position of the Values shelf among row/column dimension fields; -1 = last (default)." }, "repeatRowLabels": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Whether row labels repeat on each row." }, "rowLayout": { "oneOf": [ { "type": "string", "enum": [ "single-column" ] }, { "type": "string", "enum": [ "separate-columns" ] } ], "description": "Row dimension layout: '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": "Value layout: 'stacked' in the row shelf or 'side-by-side' in the column shelf (default)." } }, "description": "Pivot display and layout: empty cell text, value stacking, measure labels, row layout, measure shelf position, and repeat row labels." }, "adhocCalcs": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "id", "inColumn", "position" ], "properties": { "id": { "type": "string", "description": "Stable identifier for the ad hoc calculation row. Also the adhoc channel column ID." }, "inColumn": { "type": "string", "description": "Row dimension from the panel “In column” field, or 'grand-row-total'." }, "position": { "type": "string", "enum": [ "above", "below" ], "description": "Panel “Position”: 'above' or 'below' the attach row." } } }, { "type": "object", "properties": { "name": { "type": "string", "description": "Panel “Calculation name” (column display name)." }, "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": "Row dimension column ID for this parent level (Format panel “In” section)." }, "value": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ], "description": "Row dimension value at this parent level." } } }, "description": "Panel “In” section: parent row dimension values above the attach level." }, "anchorRow": { "oneOf": [ { "type": "string", "enum": [ "subtotal" ] }, { "type": "string", "enum": [ "data" ] } ], "description": "Row the calc anchors to: 'subtotal' when placed at a subtotal or grand-total row; omit for a data row." }, "calculations": { "type": "array", "items": { "type": "object", "required": [ "columnId", "formula" ], "properties": { "columnId": { "type": "string", "description": "Value column ID from the pivot values shelf." }, "formula": { "type": "string", "description": "Formula override for this value column in the ad hoc row." } } }, "description": "Per-value-column formula overrides for this ad hoc row." } } } ] }, "description": "Ad hoc calculation rows inserted into the pivot row axis." } } }, { "type": "object", "properties": { "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "Actions triggered by interacting with this element." } } } ], "description": "", "title": "Pivot Table" } ] }, { "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-text {{formula}} references." } } }, { "type": "object", "properties": { "appearance": { "oneOf": [ { "type": "string", "enum": [ "filled" ] }, { "type": "string", "enum": [ "outline" ] }, { "type": "string", "enum": [ "text" ] } ], "description": "Visual style: filled (default), outline, or text." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] }, { "type": "string", "enum": [ "stretch" ] } ], "description": "Horizontal alignment: left, center, right, or stretch." }, "size": { "oneOf": [ { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Button size: small, medium, or large." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner radius: square, round, or pill. Omit to inherit the workbook theme." }, "fillColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Background fill color: hex or theme reference." }, "fontColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Label text color: hex or theme reference." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Label font weight: 'normal' or 'bold'." }, "actions": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "trigger", "effects" ], "properties": { "trigger": { "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" ] } ], "description": "The event that fires this action." }, "effects": { "type": "array", "items": { "oneOf": [ { "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: _self (same tab), _blank (new tab), or _parent (parent frame)." } } }, { "type": "object", "properties": { "url": { "type": "string", "description": "The URL to open. Supports dynamic-text {{formula}} references." } } } ] }, { "type": "object", "required": [ "effect", "overlayId" ], "properties": { "effect": { "type": "string", "enum": [ "open-overlay" ] }, "overlayId": { "type": "string", "description": "The identifier of the modal to open. Must reference a modal page." } } }, { "type": "object", "required": [ "effect" ], "properties": { "effect": { "type": "string", "enum": [ "close-overlay" ] } } }, { "allOf": [ { "type": "object", "required": [ "effect", "control", "value" ], "properties": { "effect": { "type": "string", "enum": [ "set-control-value" ] }, "control": { "type": "string", "description": "The controlId of the control 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": "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" } ] }, { "type": "null" } ], "description": "A date value (ISO 8601 fixed or relative), or null for empty." } }, "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": "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" } ] } }, "description": "A literal value, typed to the target control.", "title": "Constant" }, { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Copy another control's current value, referenced by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "formula" ], "properties": { "type": { "type": "string", "enum": [ "formula" ] }, "formula": { "type": "string" } }, "description": "A formula expression. May reference controls, other elements, or [Selection / col] on a select trigger.", "title": "Formula" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "column" ] }, "column": { "type": "string" } }, "description": "A column on the host element's source (select triggers).", "title": "Column" } ], "description": "The value to set." } } }, { "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: replace (default), add, or remove." } } } ] }, { "allOf": [ { "type": "object", "required": [ "effect", "scope" ], "properties": { "effect": { "type": "string", "enum": [ "clear-control" ] }, "scope": { "oneOf": [ { "type": "object", "required": [ "type", "control" ], "properties": { "type": { "type": "string", "enum": [ "control" ] }, "control": { "type": "string" } }, "description": "Clear a single control, by its controlId.", "title": "Control" }, { "type": "object", "required": [ "type", "container" ], "properties": { "type": { "type": "string", "enum": [ "container" ] }, "container": { "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": { "page": { "type": "string" } } } ], "description": "Clear every control on a page (the 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": "What to clear." } } }, { "type": "object", "properties": { "usePublishedValue": { "type": "boolean", "description": "Reset to the published value instead of empty." } } } ] } ] }, "description": "Ordered effects that run when the trigger fires." } } }, { "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: 'enabled' (default) or 'disabled'." } } } ] }, "description": "Actions triggered by interacting with this button." } } } ], "description": "", "title": "Button" }, { "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 embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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. Supports embedded formulas in {{double curly braces}} with 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" }, { "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." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." } } } ] }, { "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" }, { "allOf": [ { "type": "object", "required": [ "id", "kind" ], "properties": { "id": { "type": "string", "description": "The identifier of the container." }, "kind": { "type": "string", "enum": [ "container" ] } } }, { "type": "object", "properties": { "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Visual styling: background color, border, rounded corners, and padding toggle." }, "backgroundImage": { "allOf": [ { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the background image. Supports dynamic-text {{formula}} references. Must be an external URL (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 its container: contain, cover, none, scale-down, or stretch." }, "horizontalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Horizontal alignment within the container: start, middle, or end." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical alignment within the container: start, middle, or end." }, "tiling": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "repeat" ] } ], "description": "Tiling behavior: 'none' (single image, default) or 'repeat' (tiled to fill the container)." } }, "description": "Visual customization: fit, alignment, and tiling." } } } ], "description": "Optional background image for the container. Url supports dynamic-text {{formula}} references." } } } ], "description": "", "title": "Container" }, { "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": "Orientation of the divider. Defaults to horizontal." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Alignment along the cross-axis. Defaults to middle." }, "style": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Stroke color as a hex string (e.g. \"#e0e0e0\") or theme reference." }, "width": { "type": "number", "description": "Stroke thickness in pixels." }, "strokeStyle": { "oneOf": [ { "type": "string", "enum": [ "solid" ] }, { "type": "string", "enum": [ "dashed" ] }, { "type": "string", "enum": [ "dotted" ] } ], "description": "Stroke pattern: solid, dashed, or dotted." } }, "description": "Visual customization of the divider stroke." } } } ], "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", "url" ], "properties": { "id": { "type": "string", "description": "The identifier of the image." }, "kind": { "type": "string", "enum": [ "image" ] }, "url": { "type": "string", "description": "The URL of the image. Supports dynamic-text {{formula}} references. Must be an external URL (uploads are not supported)." } } }, { "type": "object", "properties": { "alt": { "type": "string", "description": "Alternative text for the image." }, "link": { "type": "string", "description": "Optional link URL the image redirects to when clicked." }, "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 its container: contain, cover, none, scale-down, or stretch." }, "horizontalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Horizontal alignment within the container: start, middle, or end." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical alignment within the container: start, middle, or end." }, "tiling": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "repeat" ] } ], "description": "Tiling behavior: 'none' (single image, default) or 'repeat' (tiled to fill the container)." } } }, { "type": "object", "properties": { "shape": { "oneOf": [ { "type": "string", "enum": [ "rectangle" ] }, { "type": "string", "enum": [ "circle" ] } ], "description": "Image shape: rectangle or circle." } } } ] }, { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ] } ], "description": "Visual customization: fit, alignment, shape, and tiling." } } } ], "description": "", "title": "Image" }, { "allOf": [ { "type": "object", "required": [ "id", "kind", "source", "inputMode" ], "properties": { "id": { "type": "string", "description": "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": "Source of the input-table. `empty` provisions a fresh warehouse table." }, "inputMode": { "oneOf": [ { "type": "string", "enum": [ "edit" ], "description": "workbook editors only, in draft mode" }, { "type": "string", "enum": [ "explore" ], "description": "users with explore or greater permission, in published view" }, { "type": "string", "enum": [ "view" ], "description": "all users, in published view" } ], "description": "data entry permissions" } } }, { "type": "object", "properties": { "name": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "visibility" ], "properties": { "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Set to 'hidden' to explicitly hide the title (overrides the default-shown behavior)." } } }, { "allOf": [ { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Title text. Supports embedded formulas in {{double curly braces}} with optional d3 formatting via pipe, e.g. \"Total: {{Count() | ,.0f}}\"." } } }, { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Title font weight: 'normal' or 'bold'." }, "fontSize": { "type": "number", "description": "Title font size in pixels." }, "align": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Title alignment: 'start', 'middle', or 'end'." } } } ] } ], "description": "Display title. A bare string, an object `{ text, ...styling }` for font size/color/alignment/weight, 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": "Set to 'hidden' to hide the description while keeping stored text. Omit when shown." }, "text": { "type": "string", "description": "Description text." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Description font weight: 'normal' or 'bold'." }, "position": { "oneOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "below" ] }, { "type": "string", "enum": [ "tooltip" ] } ], "description": "Where the description renders: 'auto', 'below' (subtitle), or 'tooltip'. Default 'auto'." }, "fontSize": { "type": "number", "description": "Description font size in pixels." } } } ], "description": "Description (subtitle / tooltip text) plus optional styling. A bare string for text-only." }, "style": { "oneOf": [ { "allOf": [ { "type": "object", "required": [ "padding" ], "properties": { "padding": { "type": "string", "enum": [ "none" ], "description": "Set to `'none'` to drop element padding. `borderWidth` and `borderColor` cannot be set alongside. Modeled as a string literal so the vocabulary can grow (e.g. 'tight', 'loose') without a breaking change." } } }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." } } } ] }, { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Element background color (hex)." }, "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "borderWidth": { "type": "number", "description": "Border width in pixels. Cannot be set when `padding: 'none'`." }, "borderColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Border color (hex or theme reference). Cannot be set when `padding: 'none'`." } } } ], "description": "Element style: background color, border, border radius, and padding." }, "noDataText": { "type": "string", "description": "Label displayed when the input table has no data." }, "tableComponents": { "type": "object", "properties": { "table": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Input table body grid." }, "summaryBar": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Input table summary bar." } }, "description": "Visibility of the table grid and summary bar." }, "tableStyle": { "type": "object", "properties": { "preset": { "oneOf": [ { "type": "string", "enum": [ "spreadsheet" ] }, { "type": "string", "enum": [ "presentation" ] } ], "description": "Table preset: 'spreadsheet' or 'presentation'. Omit when spreadsheet (default)." }, "cellSpacing": { "oneOf": [ { "type": "string", "enum": [ "extra-small" ] }, { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Cell spacing preset: 'extra-small', 'small', 'medium', or 'large'." }, "gridLines": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "vertical" ] }, { "type": "string", "enum": [ "horizontal" ] }, { "type": "string", "enum": [ "all" ] } ], "description": "Grid lines: 'none', 'vertical', 'horizontal', or 'all'." }, "banding": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Row banding visibility: 'shown' or 'hidden'." }, "bandingColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "autofitColumns": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Autofit column widths (level table only): 'shown' or 'hidden'." }, "outerBorder": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Outer table border: 'shown' or 'hidden'. Maps to inverted store `hideOuterBorder`." }, "headerDividerColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "heavyVerticalDividers": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Heavier vertical group dividers (pivot only): 'shown' or 'hidden'." }, "heavyHorizontalDividers": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Heavier horizontal group dividers (pivot only): 'shown' or 'hidden'." }, "textStyles": { "type": "object", "properties": { "header": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "cell": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "columnHeader": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "rowHeader": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } } } } }, "description": "Table style: grid preset, spacing, grid lines, banding, autofit, dividers, and per-tab text styles." }, "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": "Protocol-managed system column id (e.g. `ID`, `CREATED_AT`). Its data type is fixed by the input-table protocol." } } }, { "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." } } } ] }, { "allOf": [ { "type": "object", "required": [ "id", "key" ], "properties": { "id": { "type": "string", "description": "Identifier of the key column in this input-table." }, "key": { "type": "string", "description": "Id of the source column (on `source.from`) this key binds to. Immutable once the input-table is created." } } }, { "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." } } } ] }, { "allOf": [ { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "description": "Warehouse column identifier." }, "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": "Allowed values for the column, presented as a single-select dropdown." }, "valuesFrom": { "type": "object", "required": [ "element", "column" ], "properties": { "element": { "type": "string", "description": "Id of a sibling element supplying the option values." }, "column": { "type": "string", "description": "Id of the column on that element to read values from." } }, "description": "Column-sourced option list (alternative to inline `values`)." }, "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 bound for a number or datetime column (datetime bounds are ISO-8601 dates)." }, "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": "Allowed file MIME types (file columns only); an absent or empty list accepts everything. Passing any one MIME type of a multi-format family (e.g. `application/msword`) selects the whole family, so a round-trip may expand the list to every MIME type in each selected family." }, "pills": { "oneOf": [ { "type": "string", "enum": [ "single-color" ] }, { "type": "string", "enum": [ "color-by-option" ] } ], "description": "Display a select column as pills. `single-color`: one shared color; `color-by-option`: a color per option. Absent shows 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": "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." } } } ] }, { "allOf": [ { "type": "object", "required": [ "id", "formula" ], "properties": { "id": { "type": "string", "description": "Identifier of the formula 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": "Columns of 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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "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": "A Sling formula returning a boolean. The formula may reference any column on the sheet, not just the styled columns." } } } ] }, { "type": "object", "properties": { "style": { "type": "object", "properties": { "backgroundColor": { "type": "string", "description": "Cell background color (hex)." }, "color": { "type": "string", "description": "Font color (hex)." }, "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 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": "Number or datetime format override for the displayed value." } } } } } ] }, { "allOf": [ { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "backgroundScale" ] } } }, { "type": "object", "required": [ "columnIds" ], "properties": { "columnIds": { "type": "array", "items": { "type": "string" }, "description": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "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": "Column IDs that this formatting applies to. Must be non-empty." } } }, { "type": "object", "properties": { "scheme": { "type": "array", "items": { "type": "string" }, "description": "Array of 2+ hex color stops that define the gradient." }, "domain": { "type": "object", "properties": { "min": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain minimum. Numeric literal, or a Sling formula string." }, "max": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain maximum. Numeric literal, or a Sling formula string." }, "mid": { "oneOf": [ { "type": "number" }, { "type": "string" } ], "description": "Domain midpoint. Presence selects a diverging scale; absence is sequential." } } }, "order": { "oneOf": [ { "type": "string", "enum": [ "descending" ] }, { "type": "string", "enum": [ "ascending" ] } ] }, "valueLabels": { "oneOf": [ { "type": "string", "enum": [ "hidden" ] }, { "type": "string", "enum": [ "shown" ] } ] } } } ] } ] }, "description": "Conditional formatting applied to columns of this input-table. Order matters: later entries apply on top of earlier ones." }, "summary": { "type": "array", "items": { "type": "string" }, "description": "Identifiers of the columns shown as aggregates in the summary bar. Each id 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 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 input-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": "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 input-table and their configurations." } } } ], "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": "Identifier of the custom 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 identifier of the element that provides data to the plugin." } } }, { "type": "object", "properties": { "groupingId": { "type": "string", "description": "The identifier of a grouping on the source element to read data at. Omit to read ungrouped (base) data." } } } ], "description": "", "title": "Element reference" }, { "allOf": [ { "type": "object", "required": [ "kind", "source" ], "properties": { "kind": { "type": "string", "enum": [ "column" ] }, "source": { "type": "string", "description": "Name of the element-reference config entry that provides the columns." } } }, { "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 identifier of the control whose value feeds this config entry." } }, "description": "", "title": "Control reference" } ] } ] }, "description": "Plugin inputs, keyed by the config name the plugin declares. Values are literals, or `kind`-tagged references to elements, columns, or controls. The set of meaningful keys is defined by the plugin itself at runtime and is not validated here." }, "style": { "type": "object", "properties": { "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Background color as a hex string (e.g. \"#ffffff\") or theme reference." } }, "description": "Visual customization of the plugin element." } } } ], "description": "", "title": "Plugin" }, { "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 for same-window), inline HTML /// 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

wrapper, e.g.

…

(aligned headings too:

…

); 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": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical alignment of body content within the tile: 'start' (top), 'middle', or 'end' (bottom). Default 'start'." }, "overflow": { "oneOf": [ { "type": "string", "enum": [ "clip" ] }, { "type": "string", "enum": [ "scroll" ] } ], "description": "Overflow behavior when content exceeds the tile: 'clip' (cut off, default) or 'scroll' (scrollbar)." } } } ], "description": "", "title": "Text" } ] }, "description": "The elements on the page." } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "page" ], "description": "Marks this as a normal page. Defaults to 'page' when omitted." }, "visibility": { "type": "string", "enum": [ "hidden" ], "description": "Page visibility. Set to `'hidden'` to hide the page from end users. Omit for a visible page. Modeled as a string literal so the vocabulary can extend to conditional visibility (e.g. per-team allowlist) without a breaking change." }, "backgroundImage": { "allOf": [ { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the background image. Supports dynamic-text {{formula}} references. Must be an external URL (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 its container: contain, cover, none, scale-down, or stretch." }, "horizontalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Horizontal alignment within the container: start, middle, or end." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical alignment within the container: start, middle, or end." }, "tiling": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "repeat" ] } ], "description": "Tiling behavior: 'none' (single image, default) or 'repeat' (tiled to fill the container)." } }, "description": "Visual customization: fit, alignment, and tiling." } } } ], "description": "Optional page-level background image. Url supports dynamic-text {{formula}} references." } } } ] } ] }, "description": "The pages of the workbook spec and their contents." } } } ] }, { "type": "object", "properties": { "themeName": { "oneOf": [ { "oneOf": [ { "type": "string", "enum": [ "Light" ] }, { "type": "string", "enum": [ "Dark" ] }, { "type": "string", "enum": [ "Surface" ] } ] }, { "type": "string" } ], "description": "Built-in theme name (`Light`, `Dark`, `Surface`) or org theme UUID." }, "themeOverrides": { "type": "object", "properties": { "borderRadius": { "oneOf": [ { "type": "string", "enum": [ "square" ] }, { "type": "string", "enum": [ "round" ] }, { "type": "string", "enum": [ "pill" ] } ], "description": "Corner rounding: 'square', 'round', or 'pill'." }, "categoricalScheme": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Categorical color palette name or custom hex array." }, "colorOverrides": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Per-token layout color overrides (hex). Keys match the theme color inspector (e.g. backgroundCanvas, elementBackground)." }, "colors": { "type": "object", "properties": { "text": { "type": "string", "description": "Primary text color (hex)." }, "highlight": { "type": "string", "description": "Highlight / accent color (hex). Maps to theme `$primary`." }, "surface": { "type": "string", "description": "Surface color (hex)." }, "success": { "type": "string", "description": "Success color (hex)." }, "warning": { "type": "string", "description": "Warning color (hex)." }, "danger": { "type": "string", "description": "Danger color (hex)." }, "darkMode": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Dark color mode: 'shown' or 'hidden'." } } }, "divergingScheme": { "type": "string", "description": "Named diverging color scheme." }, "elementBorder": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "width": { "type": "number", "description": "Element border width in pixels (0–3)." } } }, "fonts": { "type": "object", "properties": { "dataFont": { "type": "string", "description": "Data font family name (format panel: Data font)." }, "textFont": { "type": "string", "description": "Text font family name (format panel: Text font)." } } }, "hasCards": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Card-style element chrome: 'shown' or 'hidden'." }, "invertTooltipColors": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Invert tooltip colors: 'shown' or 'hidden'." }, "layoutColors": { "type": "object", "properties": { "useElementForeground": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Render elements above the canvas: 'shown' or 'hidden'." } } }, "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": "Page content width: 'full', 'large', 'medium', or 'custom'." }, "sequentialScheme": { "type": "string", "description": "Named sequential color scheme." }, "space": { "type": "object", "properties": { "showElementPadding": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Show padding around elements: 'shown' or 'hidden'." }, "unit": { "oneOf": [ { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Element spacing (format panel: Spacing): 'small', 'medium', or 'large'." } } }, "tableStyles": { "type": "object", "properties": { "preset": { "oneOf": [ { "type": "string", "enum": [ "spreadsheet" ] }, { "type": "string", "enum": [ "presentation" ] } ], "description": "Table preset: 'spreadsheet' or 'presentation'. Omit when spreadsheet (default)." }, "cellSpacing": { "oneOf": [ { "type": "string", "enum": [ "extra-small" ] }, { "type": "string", "enum": [ "small" ] }, { "type": "string", "enum": [ "medium" ] }, { "type": "string", "enum": [ "large" ] } ], "description": "Cell spacing preset: 'extra-small', 'small', 'medium', or 'large'." }, "gridLines": { "oneOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "vertical" ] }, { "type": "string", "enum": [ "horizontal" ] }, { "type": "string", "enum": [ "all" ] } ], "description": "Grid lines: 'none', 'vertical', 'horizontal', or 'all'." }, "banding": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Row banding visibility: 'shown' or 'hidden'." }, "bandingColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "autofitColumns": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Autofit column widths (level table only): 'shown' or 'hidden'." }, "outerBorder": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Outer table border: 'shown' or 'hidden'. Maps to inverted store `hideOuterBorder`." }, "headerDividerColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "heavyVerticalDividers": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Heavier vertical group dividers (pivot only): 'shown' or 'hidden'." }, "heavyHorizontalDividers": { "oneOf": [ { "type": "string", "enum": [ "shown" ] }, { "type": "string", "enum": [ "hidden" ] } ], "description": "Heavier horizontal group dividers (pivot only): 'shown' or 'hidden'." }, "textStyles": { "type": "object", "properties": { "header": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "cell": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "columnHeader": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } }, "rowHeader": { "type": "object", "properties": { "font": { "type": "string", "description": "Font family name." }, "fontSize": { "type": "number", "description": "Font size in pixels." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ], "description": "Font weight: 'normal' or 'bold'." }, "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "backgroundColor": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "align": { "oneOf": [ { "type": "string", "enum": [ "left" ] }, { "type": "string", "enum": [ "center" ] }, { "type": "string", "enum": [ "right" ] } ], "description": "Horizontal text alignment: left, center, or right." }, "verticalAlign": { "oneOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "middle" ] }, { "type": "string", "enum": [ "end" ] } ], "description": "Vertical text alignment: 'start', 'middle', or 'end'." }, "textWrap": { "oneOf": [ { "type": "string", "enum": [ "wrap" ] }, { "type": "string", "enum": [ "clip" ] } ], "description": "Text overflow: 'wrap' or 'clip'." } } } } } } }, "titleFont": { "type": "object", "properties": { "color": { "oneOf": [ { "type": "string" }, { "type": "object", "required": [ "kind", "ref" ], "properties": { "kind": { "type": "string", "enum": [ "theme" ] }, "ref": { "type": "string" } } } ], "description": "Hex color (`#rgb` or `#rrggbb`) or theme color reference `{ kind: \"theme\", ref: \"colors-xxx\" }`." }, "fontSize": { "type": "number", "description": "Title font size in pixels (6–96)." }, "fontWeight": { "oneOf": [ { "type": "string", "enum": [ "normal" ] }, { "type": "string", "enum": [ "bold" ] } ] } } } } } } }, { "type": "object", "properties": { "layout": { "oneOf": [ { "type": "string" }, { "type": "null" } ], "description": "Grid layout as XML.", "title": "Layout XML" } } } ] }, { "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": { "": 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- **[Deprecated]** Using the `search` parameter is deprecated. If using `search` to filter by email address, you must URL encode the \"@\" character as `%40`.\n- Using `email` and `search` together is not supported.\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": "search", "schema": { "type": "string", "description": "**[Deprecated]** Use the `email` query parameter instead." }, "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", "elementName", "schedule", "configuredAt", "paused" ], "properties": { "sheetId": { "type": "string", "description": "Identifier of the materialization schedule for the element", "title": "Sheet 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": "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" } ] }