{ "openapi": "3.0.0", "info": { "title": "ThoughtSpot Public REST API", "version": "2.0" }, "x-roles": [ { "name": "26.2.0.cl", "id": "26.2.0.cl", "tags": [ "26.2.0.cl" ], "description": "Roles for version 26.2.0.cl" }, { "name": "26.10.0.cl", "id": "26.10.0.cl", "tags": [ "26.10.0.cl" ], "description": "Roles for version 26.10.0.cl" }, { "name": "10.4.0.cl", "id": "10.4.0.cl", "tags": [ "10.4.0.cl" ], "description": "Roles for version 10.4.0.cl" }, { "name": "26.7.0.cl", "id": "26.7.0.cl", "tags": [ "26.7.0.cl" ], "description": "Roles for version 26.7.0.cl" }, { "name": "26.8.0.cl", "id": "26.8.0.cl", "tags": [ "26.8.0.cl" ], "description": "Roles for version 26.8.0.cl" }, { "name": "26.6.0.cl", "id": "26.6.0.cl", "tags": [ "26.6.0.cl" ], "description": "Roles for version 26.6.0.cl" }, { "name": "10.15.0.cl", "id": "10.15.0.cl", "tags": [ "10.15.0.cl" ], "description": "Roles for version 10.15.0.cl" }, { "name": "10.13.0.cl", "id": "10.13.0.cl", "tags": [ "10.13.0.cl" ], "description": "Roles for version 10.13.0.cl" }, { "name": "26.9.0.cl", "id": "26.9.0.cl", "tags": [ "26.9.0.cl" ], "description": "Roles for version 26.9.0.cl" }, { "name": "10.7.0.cl", "id": "10.7.0.cl", "tags": [ "10.7.0.cl" ], "description": "Roles for version 10.7.0.cl" }, { "name": "26.5.0.cl", "id": "26.5.0.cl", "tags": [ "26.5.0.cl" ], "description": "Roles for version 26.5.0.cl" }, { "name": "9.0.0.cl", "id": "9.0.0.cl", "tags": [ "9.0.0.cl" ], "description": "Roles for version 9.0.0.cl" }, { "name": "9.4.0.cl", "id": "9.4.0.cl", "tags": [ "9.4.0.cl" ], "description": "Roles for version 9.4.0.cl" }, { "name": "9.12.0.cl", "id": "9.12.0.cl", "tags": [ "9.12.0.cl" ], "description": "Roles for version 9.12.0.cl" }, { "name": "26.4.0.cl", "id": "26.4.0.cl", "tags": [ "26.4.0.cl" ], "description": "Roles for version 26.4.0.cl" }, { "name": "10.12.0.cl", "id": "10.12.0.cl", "tags": [ "10.12.0.cl" ], "description": "Roles for version 10.12.0.cl" }, { "name": "9.2.0.cl", "id": "9.2.0.cl", "tags": [ "9.2.0.cl" ], "description": "Roles for version 9.2.0.cl" }, { "name": "9.9.0.cl", "id": "9.9.0.cl", "tags": [ "9.9.0.cl" ], "description": "Roles for version 9.9.0.cl" }, { "name": "9.6.0.cl", "id": "9.6.0.cl", "tags": [ "9.6.0.cl" ], "description": "Roles for version 9.6.0.cl" }, { "name": "10.10.0.cl", "id": "10.10.0.cl", "tags": [ "10.10.0.cl" ], "description": "Roles for version 10.10.0.cl" }, { "name": "10.6.0.cl", "id": "10.6.0.cl", "tags": [ "10.6.0.cl" ], "description": "Roles for version 10.6.0.cl" }, { "name": "10.3.0.cl", "id": "10.3.0.cl", "tags": [ "10.3.0.cl" ], "description": "Roles for version 10.3.0.cl" }, { "name": "10.1.0.cl", "id": "10.1.0.cl", "tags": [ "10.1.0.cl" ], "description": "Roles for version 10.1.0.cl" }, { "name": "10.9.0.cl", "id": "10.9.0.cl", "tags": [ "10.9.0.cl" ], "description": "Roles for version 10.9.0.cl" }, { "name": "10.8.0.cl", "id": "10.8.0.cl", "tags": [ "10.8.0.cl" ], "description": "Roles for version 10.8.0.cl" }, { "name": "9.5.0.cl", "id": "9.5.0.cl", "tags": [ "9.5.0.cl" ], "description": "Roles for version 9.5.0.cl" }, { "name": "26.3.0.cl", "id": "26.3.0.cl", "tags": [ "26.3.0.cl" ], "description": "Roles for version 26.3.0.cl" }, { "name": "10.14.0.cl", "id": "10.14.0.cl", "tags": [ "10.14.0.cl" ], "description": "Roles for version 10.14.0.cl" }, { "name": "9.7.0.cl", "id": "9.7.0.cl", "tags": [ "9.7.0.cl" ], "description": "Roles for version 9.7.0.cl" } ], "tags": [], "paths": { "/api/rest/2.0/ai/agent/conversation/create": { "post": { "operationId": "createAgentConversation", "description": "\n Version: 26.2.0.cl or later\n\nVersion: 26.2.0.cl or later\n\nCreates a new Spotter agent conversation based on the provided context and settings. The endpoint was in Beta from 26.2.0.cl through 26.4.0.cl.\n\nRequires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request.\n\n#### Usage guidelines\n\nThe conversation context is defined by exactly one of the following parameters:\n\n- `metadata_context`: defines the conversation context by data source. The context type can be one of:\n - `DATA_SOURCE` *(available from 26.5.0.cl)*: targets a specific data source. Provide `data_source_identifier` in `data_source_context` for a single data source, or `data_source_identifiers` for multi-data-source context. The deprecated `guid` field is accepted for backwards compatibility.\n - `AUTO_MODE` *(available from 26.5.0.cl)*: automatically discovers and selects the most relevant datasets for the user's queries.\n- `analyst_identifier` *(available from 26.10.0.cl)*: unique identifier of a Spotter Analyst to start the conversation from. The conversation uses the analyst's configuration — its data sources, agent instructions, and connectors — so `metadata_context` must be omitted. The caller must be the analyst's author, have the analyst shared with them, or hold admin / Spotter-management privileges.\n\nPassing both `analyst_identifier` and `metadata_context`, or neither, is rejected.\n\n> **Note for callers on versions 26.2.0.cl – 26.4.0.cl (Beta):** use the lowercase `data_source` enum value with the `guid` field instead of the above. Example: `{ \"type\": \"data_source\", \"data_source_context\": { \"guid\": \"\" } }`.\n\nThe `conversation_settings` parameter controls which Spotter capabilities are enabled for the conversation:\n\n- `enable_contextual_change_analysis` (default: `true`, **deprecated from 26.2.0.cl**) — always enabled in Spotter 3; setting this to `false` has no effect on versions >= 26.2.0.cl\n- `enable_natural_language_answer_generation` (default: `true`, **deprecated from 26.2.0.cl**) — always enabled in Spotter 3; setting this to `false` has no effect on versions >= 26.2.0.cl\n- `enable_reasoning` (default: `true`, **deprecated from 26.2.0.cl**) — always enabled in Spotter 3; setting this to `false` has no effect on versions >= 26.2.0.cl\n- `enable_save_chat` (default: `false`, *available from 26.5.0.cl*) — enables saving the conversation for later retrieval via conversation history\n\nIf the request is successful, the response includes a unique `conversation_identifier` that must be passed to `sendAgentConversationMessage` or `sendAgentConversationMessageStreaming` to send messages within this conversation. The response also includes `conversation_id` with the same value for backwards compatibility; use `conversation_identifier` for new integrations. When the conversation is started from an analyst, the response additionally carries the analyst's `analyst_id`; it is `null` otherwise.\n\n#### Example request\n\n```json\n{\n \"metadata_context\": {\n \"type\": \"DATA_SOURCE\",\n \"data_source_context\": {\n \"data_source_identifier\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n }\n },\n \"conversation_settings\": {}\n}\n```\n\n#### Error responses\n\n| Code | Description |\n| ---- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege, lacks view permission on the specified metadata object, or has no access to the analyst specified in `analyst_identifier`. |\n| 404 | Not found — no analyst with the given `analyst_identifier` exists in the caller's Org. |\n| 422 | Unprocessable entity — the request fails validation: both `analyst_identifier` and `metadata_context` were provided, neither was provided, or `metadata_context` is malformed (for example, `DATA_SOURCE` context without a data source identifier). |\n\n> ###### Note:\n>\n> - This endpoint was in Beta from 26.2.0.cl through 26.4.0.cl and is Generally Available from version 26.5.0.cl.\n> - This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentConversationRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentConversation" }, "examples": { "example_1": { "summary": "Create a conversation with a specific data source", "value": { "conversation_id": "wwHQ5j8O8dQC", "conversation_identifier": "wwHQ5j8O8dQC" } }, "example_2": { "summary": "Create a conversation using auto mode where the agent automatically discovers and selects the most relevant datasets for the user's queries", "value": { "conversation_id": "aaHQ5j8O8dQC", "conversation_identifier": "aaHQ5j8O8dQC" } }, "example_3": { "summary": "Create a conversation from a Spotter Analyst", "value": { "conversation_id": "bbHQ5j8O8dQC", "conversation_identifier": "bbHQ5j8O8dQC", "analyst_id": "9f8e7d6c-5b4a-3210-fedc-ba9876543210" } } } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentConversation" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/analysts/create": { "post": { "operationId": "createAnalyst", "description": "\nCreates a Spotter Analyst: a configured agent with a name, description,\nat least one data source, and optional agent instructions, MCP\nconnectors, and starter prompts. Analysts created via API use the default\nicon until one is set in the UI.\nRequires at least one of `ADMINISTRATION`, `CAN_MANAGE_SPOTTER`, or\n`CAN_USE_SPOTTER` privileges, plus view access to every data source\nreferenced in `sources`.
Beta Version: 26.10.0.cl or later\n\nVersion: 26.10.0.cl or later\n\nCreates a Spotter Analyst: a configured agent with a name, description, data sources, and optional agent instructions, MCP connectors, and starter prompts that your users converse with in Spotter.\n\nRequires at least one of `ADMINISTRATION`, `CAN_MANAGE_SPOTTER`, or `CAN_USE_SPOTTER` privileges, plus view access to every data source referenced in `sources`. Use a bearer token for the Org in which the analyst should be created.\n\n#### Usage guidelines\n\nThe request body is flat — all fields are top-level:\n\n- `name` (required): display name of the analyst.\n- `description` (required): up to 200 characters.\n- `instructions` (optional): natural-language instructions that guide the agent's behavior for this analyst. Instructions that conflict with system guardrails are rejected with `409`.\n- `sources` (required): at least one data source the analyst can query, each with an `identifier`, an optional `name`, and a `type` (`MODEL`, `ANSWER`, `LIVEBOARD`, or `CONVERSATION`). The caller must have view access to every referenced source.\n- `mcp_connector_identifiers` (optional): identifiers of MCP connectors to link to the analyst.\n- `starter_prompts` (optional): up to 4 plain-text prompts shown on the analyst landing page, each between 10 and 250 characters. Display order follows list position.\n\nIf the request is successful, the response contains the created analyst, including the server-assigned `id`. In responses, sources are returned with `id` and `type`, connector identifiers as `mcp_connectors`, starter prompts as structured objects (`label`, `text`, `order`, `is_ai_generated`), the last-update time as `updated_time_in_millis` (epoch milliseconds), and the `created_by` and `updated_by` users.\n\n#### Error conditions\n\n- `403` — missing privileges, or no view access to a referenced data source.\n- `409` — `instructions` conflict with system guardrails.\n- `422` — validation failure, such as a missing required field (`name`, `description`, or `sources`), an empty `sources` list, too many starter prompts, or field-length violations.\n- `429` — rate limit exceeded.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.10.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnalystRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Analyst" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Analyst" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/conversation/create": { "post": { "operationId": "createConversation", "description": "\nBeta Version: 10.4.0.cl or later\n\nVersion: 10.4.0.cl or later\n\nCreates a new conversation session tied to a specific data model for AI-driven natural language querying.\n\nRequires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request.\n\n#### Usage guidelines\n\nThe request must include:\n- `metadata_identifier`: the unique ID of the data source that provides context for the conversation\n\nOptionally, you can provide:\n- `tokens`: a token string to set initial context for the conversation (e.g., `\"[sales],[item type],[state]\"`)\n\nIf the request is successful, ThoughtSpot returns a unique `conversation_identifier` that must be passed to `sendMessage` to continue the conversation.\n\n#### Error responses\n\n| Code | Description |\n|------|-------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the specified metadata object. |\n\n> ###### Note:\n> * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "10.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConversationRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conversation" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conversation" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/analysts/{analyst_identifier}/delete": { "post": { "operationId": "deleteAnalyst", "description": "\nPermanently deletes a Spotter Analyst. This operation is irreversible —\ndeleted analysts cannot be recovered. The request has no body; the\nresponse contains the `id` of the deleted analyst.\nRequires ownership of the analyst, or `ADMINISTRATION` or\n`CAN_MANAGE_SPOTTER` privileges.
Beta Version: 26.10.0.cl or later\n\nVersion: 26.10.0.cl or later\n\nPermanently deletes a Spotter Analyst. This operation is irreversible — deleted analysts cannot be recovered.\n\nRequires ownership of the analyst, or `ADMINISTRATION` or `CAN_MANAGE_SPOTTER` privileges. Users the analyst is shared with cannot delete it. Use a bearer token for the Org in which the analyst exists.\n\n#### Usage guidelines\n\nThe request has no body — the analyst to delete is identified by the `analyst_identifier` path parameter, as returned by the create analyst API.\n\nA successful request returns the `id` of the deleted analyst.\n\n#### Error conditions\n\n- `400` — malformed analyst identifier.\n- `403` — the caller is not the analyst's author and lacks admin / Spotter-management privileges.\n- `404` — no analyst with the given identifier exists in the caller's Org.\n- `429` — rate limit exceeded.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.10.0.cl" ], "parameters": [ { "in": "path", "name": "analyst_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the analyst to delete." } ], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalystDeleteResponse" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalystDeleteResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/conversations/{conversation_identifier}/delete": { "delete": { "operationId": "deleteConversation", "description": "\nDeletes an existing agent conversation.
Version: 26.7.0.cl or later\n\nPermanently deletes an existing saved agent conversation and all its associated messages. This operation is irreversible — deleted conversations cannot be recovered.\n\nRequires `CAN_USE_SPOTTER` privilege and ownership of the conversation being deleted.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `conversation_identifier` *(path parameter)*: the unique ID of the conversation to delete, as returned by `createAgentConversation` or `getConversationList`\n\nA successful request returns an empty `204 No Content` response. The deleted conversation no longer appears in `getConversationList`.\n\n#### Example request\n\n```bash\nDELETE /api/rest/2.0/ai/agent/conversations/{conversation_identifier}/delete\n```\n\n#### Error responses\n\n| Code | Description |\n|------|-------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or does not own the specified conversation. |\n| 404 | Not Found — no conversation exists with the given `conversation_identifier` for the authenticated user. |\n\n> ###### Note:\n>\n> - Deletion is permanent and cannot be undone. Ensure the correct `conversation_identifier` is used before calling this endpoint.\n> - Only conversations created with `enable_save_chat: true` are persisted and can be deleted via this endpoint.\n> - Available from version 26.7.0.cl and later.\n> - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.7.0.cl" ], "parameters": [ { "in": "path", "name": "conversation_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the conversation to delete." } ], "responses": { "204": { "description": "Successfully deleted the agent conversation." }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/memory/export": { "post": { "operationId": "exportMemory", "description": "\nExports memory entries (rules, recipes, and always-apply rules) for\nthe specified data-models as a single YAML payload. The payload can\nbe edited locally and re-submitted through `importMemory`.\nRequires Spotter access (use/manage) and either edit or memory\naccess on corresponding data model sources.
Beta Version: 26.8.0.cl or later\n\nThis API allows users to export data-model memories for a given list of data-models. This exported yaml file can then be modified and used as input to the import API in target env.\n\nThis API enables customers to migrate memories from a source env to a target env. This improves memory adoption for Spotter by giving the users a chance to develop their memories in one env and replicate the same in another env.\n\n#### Usage guidelines\n\nTo export memory for one or more data-models, the request may include:\n- `sources`: A list of typed scope groups identifying which data-models to export memory for. Each group contains:\n - `type`: The source object type for this group — `DATA_MODEL`.\n - `identifiers`: An array of GUIDs or human-readable `obj_id`s of the data-models to export memory for. obj_ids are resolved server-side before forwarding.\n\nThe API returns a response object with:\n- `content`: The serialized memory payload (YAML) — exactly the shape that the `importMemory` API consumes. Edit it locally and pass it back through `importMemory` to apply changes.\n\n#### Source Type\n\n- **DATA_MODEL**: The `identifiers` are data-model GUIDs. This is the default source type for Spotter memory and covers the rules, recipes and always-apply rules attached directly to a data-model.\n\n#### File format\n\nThe exported `content` is a YAML document with a single top-level `memories` key holding a list of memory items — exactly the format the `importMemory` API consumes. The full format reference (an annotated example, memory item fields, per-type content, and `datamodel_sources` identification) is documented in the `importMemory` API's **File format** section. Exported files populate each source's `guid` and, if present, `obj_id` as well.\n\n#### Error responses\n\n| Code | Description |\n|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have necessary permissions, or lacks read access on a referenced data-model, or the bearer token does not correspond to the data-model's org. |\n\n> ###### Note:\n> - To use this API, the user needs Spotter access (use/manage) and either edit or memory access on the data-model and they must use corresponding org related bearerToken where the data-model exists.\n> - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> - Available from version 26.8.0.cl and later.\n> - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.8.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportMemoryRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportMemoryResponse" }, "examples": { "example_1": { "summary": "Serialized YAML memory payload returned", "value": { "content": "memories:\n- type: RULE\n content:\n rule_definition: \"Earnings: total sales filtered to West region only.\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RULE\n content:\n rule_definition: \"Geographic data is organized in a three-level hierarchy from broadest to most specific: Region (highest level) → State (middle level) → County (lowest level). This hierarchical structure enables progressive drill-down analysis, where each level provides increasingly granular geographic segmentation for sales and quantity metrics.\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RULE\n content:\n rule_definition: \"Hot products: top 5 products by total sales (no region filter applied).\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RECIPE\n content:\n user_query: Calculate earnings for East region current year\n recipe: \"{\\\"task\\\": \\\"Compute earnings by extracting sales and filtering to East region for the current year\\\", \\\"steps\\\": [{\\\"instruction\\\": \\\"Extract sales, then apply a filter for current year and a filter for East region.\\\", \\\"analytical_mappings\\\": {\\\"tml_tokens\\\": [\\\"[sales] [date] = 'this year' [region] = 'east'\\\"], \\\"formulas\\\": []}}]}\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RECIPE\n content:\n user_query: Total sales for East region current year\n recipe: \"{\\\"task\\\": \\\"Compute total sales filtered to East region for the current year\\\", \\\"steps\\\": [{\\\"instruction\\\": \\\"Calculate total sales where region is East and date is current year.\\\", \\\"analytical_mappings\\\": {\\\"tml_tokens\\\": [\\\"[sales] [date] = 'this year' [region] = 'east'\\\"], \\\"formulas\\\": []}}]}\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RECIPE\n content:\n user_query: What is the total quantity purchased by city and region?\n recipe: \"{\\\"task\\\":\\\"Calculate total quantity purchased grouped by city and region\\\",\\\"steps\\\":[{\\\"instruction\\\":\\\"Sum the quantity purchased metric and group the results by city and region to show purchasing volumes across different geographic locations\\\",\\\"analytical_mappings\\\":{\\\"tml_tokens\\\":[\\\"[quantity purchased] [city] [region]\\\"],\\\"formulas\\\":[]}}]}\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RECIPE\n content:\n user_query: What were total jacket sales in 2024?\n recipe: \"{\\\"task\\\":\\\"Compute the aggregate 2024 jacket sales revenue.\\\",\\\"steps\\\":[{\\\"instruction\\\":\\\"Shows the total sales revenue for jackets in 2024. This provides a high-level metric to understand overall jacket sales performance for the year.\\\",\\\"analytical_mappings\\\":{\\\"tml_tokens\\\":[\\\"[sales] [item type] = [item type].\\\\\\\"jackets\\\\\\\" [date] = \\\\\\\"2024\\\\\\\"\\\"],\\\"formulas\\\":[]}}]}\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RECIPE\n content:\n user_query: How are monthly sales and quantity tracking by state?\n recipe: \"{\\\"task\\\":\\\"Aggregate monthly sales and quantity by state for a state-level performance view.\\\",\\\"steps\\\":[{\\\"instruction\\\":\\\"Shows monthly sales and quantity purchased metrics organized by state. Provides a state-wise view of sales performance with additional dimensional context.\\\",\\\"analytical_mappings\\\":{\\\"tml_tokens\\\":[\\\"[sales] [quantity purchased] [state] [date]\\\"],\\\"formulas\\\":[]}}]}\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RECIPE\n content:\n user_query: \"What's the quarterly sales and quantity by region and state for the last 3 years, with yearly rollups?\"\n recipe: \"{\\\"task\\\":\\\"Build a 3-year quarterly view of sales and quantity grouped by region and state, with quarterly and yearly aggregation.\\\",\\\"steps\\\":[{\\\"instruction\\\":\\\"Displays quarterly performance metrics including sales and quantity purchased, broken down by region and state over the last 3 years. Enables analysis of regional and state-level trends with both quarterly and yearly views.\\\",\\\"analytical_mappings\\\":{\\\"tml_tokens\\\":[\\\"[sales] [quantity purchased] [region] [state] [date].\\\\\\\"quarterly\\\\\\\" [date].\\\\\\\"last 3 years\\\\\\\" [date].\\\\\\\"yearly\\\\\\\"\\\"],\\\"formulas\\\":[]}}]}\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RECIPE\n content:\n user_query: How are we doing against quarterly sales and quantity targets per region?\n recipe: \"{\\\"task\\\":\\\"Render bullet charts contrasting quarterly actual vs target sales and quantity per region.\\\",\\\"steps\\\":[{\\\"instruction\\\":\\\"Compares actual quarterly sales and quantity metrics against targets by region using bullet charts. Provides a target vs actual performance view to track progress.\\\",\\\"analytical_mappings\\\":{\\\"tml_tokens\\\":[\\\"[sales] [quantity purchased] [region] [date].\\\\\\\"quarterly\\\\\\\" [Target sales] [Target quantity]\\\"],\\\"formulas\\\":[\\\"{\\\\\\\"name\\\\\\\": \\\\\\\"Target sales\\\\\\\", \\\\\\\"expression\\\\\\\": \\\\\\\"random ( ) * sum ( sales ) * 2\\\\\\\"}\\\",\\\"{\\\\\\\"name\\\\\\\": \\\\\\\"Target quantity\\\\\\\", \\\\\\\"expression\\\\\\\": \\\\\\\"random ( ) * sum ( quantity purchased ) * 2\\\\\\\"}\\\"]}}]}\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n" } }, "example_2": { "summary": "Serialized YAML memory payload returned", "value": { "content": "memories:\n- type: RULE\n content:\n rule_definition: \"Earnings: total sales filtered to West region only.\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RULE\n content:\n rule_definition: \"Hot products: top 5 products by total sales (no region filter applied).\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RULE\n content:\n rule_definition: \"Geographic data is organized in a three-level hierarchy from broadest to most specific: Region (highest level) → State (middle level) → County (lowest level). This hierarchical structure enables progressive drill-down analysis, where each level provides increasingly granular geographic segmentation for sales and quantity metrics.\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RULE\n content:\n rule_definition: \"When analyzing quantity purchased, apply a date filter for the last 3 years.\"\n datamodel_sources:\n - guid: 44444444-4444-4444-4444-444444444444\n obj_id: sample-model\n tags: []\n- type: RULE\n content:\n rule_definition: User's total sales target is 1 million USD.\n datamodel_sources:\n - guid: 44444444-4444-4444-4444-444444444444\n obj_id: sample-model\n tags: []\n- type: RULE\n content:\n rule_definition: Sales analyses must filter to east region only.\n datamodel_sources:\n - guid: 44444444-4444-4444-4444-444444444444\n obj_id: sample-model\n tags: []\n- type: RECIPE\n content:\n user_query: Calculate earnings for East region current year\n recipe: \"{\\\"task\\\": \\\"Compute earnings by extracting sales and filtering to East region for the current year\\\", \\\"steps\\\": [{\\\"instruction\\\": \\\"Extract sales, then apply a filter for current year and a filter for East region.\\\", \\\"analytical_mappings\\\": {\\\"tml_tokens\\\": [\\\"[sales] [date] = 'this year' [region] = 'east'\\\"], \\\"formulas\\\": []}}]}\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RECIPE\n content:\n user_query: Total sales for East region current year\n recipe: \"{\\\"task\\\": \\\"Compute total sales filtered to East region for the current year\\\", \\\"steps\\\": [{\\\"instruction\\\": \\\"Calculate total sales where region is East and date is current year.\\\", \\\"analytical_mappings\\\": {\\\"tml_tokens\\\": [\\\"[sales] [date] = 'this year' [region] = 'east'\\\"], \\\"formulas\\\": []}}]}\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RECIPE\n content:\n user_query: What is the total quantity purchased by city and region?\n recipe: \"{\\\"task\\\":\\\"Calculate total quantity purchased grouped by city and region\\\",\\\"steps\\\":[{\\\"instruction\\\":\\\"Sum the quantity purchased metric and group the results by city and region to show purchasing volumes across different geographic locations\\\",\\\"analytical_mappings\\\":{\\\"tml_tokens\\\":[\\\"[quantity purchased] [city] [region]\\\"],\\\"formulas\\\":[]}}]}\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RECIPE\n content:\n user_query: \"What's the quarterly sales and quantity by region and state for the last 3 years, with yearly rollups?\"\n recipe: \"{\\\"task\\\":\\\"Build a 3-year quarterly view of sales and quantity grouped by region and state, with quarterly and yearly aggregation.\\\",\\\"steps\\\":[{\\\"instruction\\\":\\\"Displays quarterly performance metrics including sales and quantity purchased, broken down by region and state over the last 3 years. Enables analysis of regional and state-level trends with both quarterly and yearly views.\\\",\\\"analytical_mappings\\\":{\\\"tml_tokens\\\":[\\\"[sales] [quantity purchased] [region] [state] [date].\\\\\\\"quarterly\\\\\\\" [date].\\\\\\\"last 3 years\\\\\\\" [date].\\\\\\\"yearly\\\\\\\"\\\"],\\\"formulas\\\":[]}}]}\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RECIPE\n content:\n user_query: How are we doing against quarterly sales and quantity targets per region?\n recipe: \"{\\\"task\\\":\\\"Render bullet charts contrasting quarterly actual vs target sales and quantity per region.\\\",\\\"steps\\\":[{\\\"instruction\\\":\\\"Compares actual quarterly sales and quantity metrics against targets by region using bullet charts. Provides a target vs actual performance view to track progress.\\\",\\\"analytical_mappings\\\":{\\\"tml_tokens\\\":[\\\"[sales] [quantity purchased] [region] [date].\\\\\\\"quarterly\\\\\\\" [Target sales] [Target quantity]\\\"],\\\"formulas\\\":[\\\"{\\\\\\\"name\\\\\\\": \\\\\\\"Target sales\\\\\\\", \\\\\\\"expression\\\\\\\": \\\\\\\"random ( ) * sum ( sales ) * 2\\\\\\\"}\\\",\\\"{\\\\\\\"name\\\\\\\": \\\\\\\"Target quantity\\\\\\\", \\\\\\\"expression\\\\\\\": \\\\\\\"random ( ) * sum ( quantity purchased ) * 2\\\\\\\"}\\\"]}}]}\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RECIPE\n content:\n user_query: How are monthly sales and quantity tracking by state?\n recipe: \"{\\\"task\\\":\\\"Aggregate monthly sales and quantity by state for a state-level performance view.\\\",\\\"steps\\\":[{\\\"instruction\\\":\\\"Shows monthly sales and quantity purchased metrics organized by state. Provides a state-wise view of sales performance with additional dimensional context.\\\",\\\"analytical_mappings\\\":{\\\"tml_tokens\\\":[\\\"[sales] [quantity purchased] [state] [date]\\\"],\\\"formulas\\\":[]}}]}\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RECIPE\n content:\n user_query: What were total jacket sales in 2024?\n recipe: \"{\\\"task\\\":\\\"Compute the aggregate 2024 jacket sales revenue.\\\",\\\"steps\\\":[{\\\"instruction\\\":\\\"Shows the total sales revenue for jackets in 2024. This provides a high-level metric to understand overall jacket sales performance for the year.\\\",\\\"analytical_mappings\\\":{\\\"tml_tokens\\\":[\\\"[sales] [item type] = [item type].\\\\\\\"jackets\\\\\\\" [date] = \\\\\\\"2024\\\\\\\"\\\"],\\\"formulas\\\":[]}}]}\"\n datamodel_sources:\n - guid: 33333333-3333-3333-3333-333333333333\n obj_id: sales-model\n tags: []\n- type: RECIPE\n content:\n user_query: What were jacket sales by region in 2024?\n recipe: \"{\\\"task\\\":\\\"Break out 2024 jacket sales revenue by region to compare regional performance.\\\",\\\"steps\\\":[{\\\"instruction\\\":\\\"Shows jacket sales revenue broken down by region for 2024. This helps identify which geographic regions are performing best in jacket sales and enables regional performance comparison.\\\",\\\"analytical_mappings\\\":{\\\"tml_tokens\\\":[\\\"[sales] by [region] [item type] = [item type].\\\\\\\"jackets\\\\\\\" [date] = \\\\\\\"2024\\\\\\\"\\\"],\\\"formulas\\\":[]}}]}\"\n datamodel_sources:\n - guid: 44444444-4444-4444-4444-444444444444\n obj_id: sample-model\n tags: []\n- type: RECIPE\n content:\n user_query: \"Show me quarterly sales and quantity trends over the past 3 years, newest first.\"\n recipe: \"{\\\"task\\\":\\\"Plot quarterly sales and quantity trends for the past 3 years in reverse chronological order.\\\",\\\"steps\\\":[{\\\"instruction\\\":\\\"Presents quarterly sales and quantity purchased trends over the last 3 years, sorted by most recent periods first. Enables time-based analysis of sales performance.\\\",\\\"analytical_mappings\\\":{\\\"tml_tokens\\\":[\\\"[sales] [quantity purchased] [date].\\\\\\\"quarterly\\\\\\\" [date].\\\\\\\"last 3 years\\\\\\\"\\\"],\\\"formulas\\\":[]}}]}\"\n datamodel_sources:\n - guid: 44444444-4444-4444-4444-444444444444\n obj_id: sample-model\n tags: []\n" } } } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportMemoryResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/instructions/get": { "get": { "operationId": "getAgentInstructions", "description": "\nBeta Version: 26.6.0.cl or later\n\nRetrieves the admin instructions currently configured for the AI agent (Spotter). Admin instructions are tenant- and org-scoped text that guide agent behavior across all conversations.\n\nRequires admin privileges. Only users with org admin access can retrieve agent instructions.\n\n#### Usage guidelines\n\nNo input parameters are required. The API returns the stored `AgentInstructions` record for the caller's tenant and org.\n\nIf no instructions have been configured yet, the API returns a record with an empty `instructions` field and `null` values for `id`, `created_at`, `updated_at`, and `last_updated_by`.\n\nIf the request is successful, the response includes:\n\n- `id`: unique identifier of the instructions record\n- `instructions`: the configured instructions text\n- `created_at`: ISO timestamp when the instructions were first saved\n- `updated_at`: ISO timestamp when the instructions were last updated\n- `last_updated_by`: user ID of the admin who last updated the instructions (may be `null` for older records)\n\n#### Error responses\n\n| Code | Description |\n|------|-------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have org admin privileges required to read agent instructions. |\n\n> ###### Note:\n>\n> - Use `setAgentInstructions` to create or update agent instructions.\n> - Available from version 26.6.0.cl and later.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.6.0.cl" ], "parameters": [], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentInstructions" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentInstructions" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/conversations/{conversation_identifier}/messages": { "get": { "operationId": "getConversation", "description": "\nRetrieves the full public-safe content of a saved agent conversation: ordered\nturns (user messages and agent response items) and sanitized code-execution\nfile metadata. Internal graph or branch state, Azure file identifiers, and\nmessages with a `SYSTEM` source are omitted. The full answer payload is not\nembedded; fetch it separately via `loadAnswer` using the `answer_id` on each\n`answer` response item.\nRequires `CAN_USE_SPOTTER` privilege and access to the specified conversation.
Version: 26.7.0.cl or later\n\nRetrieves the full public-safe content of a saved agent conversation. Returns ordered conversation messages — each carrying an optional user prompt (the user's message and any attachments) and the agent response items produced for that turn — plus sanitized metadata for any files generated by the code-execution tool. \n\nUse this endpoint to render a persisted conversation in a UI, build an audit trail, or post-process a completed conversation. The full answer payload is not embedded — fetch it separately via `loadAnswer` using the `answer_id` on each `answer` response item.\n\nRequires `CAN_USE_SPOTTER` privilege and access to the specified conversation.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `conversation_identifier` _(path parameter)_: the unique ID of the conversation, as returned by `createAgentConversation` or `getConversationList`.\n\nIf the request is successful, the response contains two top-level fields:\n\n| Field | Type | Description |\n| ---------------------- | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `messages` | `ConversationMessage[]` | Ordered oldest to newest. Empty array when the conversation has no messages. |\n| `code_execution_files` | `CodeExecutionFileMetadata[]` | List of sanitized file metadata entries (one per `file_id`). Covers all code-execution-generated files referenced anywhere in the conversation. Empty array when there are none. |\n\nNo other top-level fields are returned.\n\n#### ConversationMessage fields\n\n| Field | Type | Description |\n| --------------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------- |\n| `message_id` | `String` | Stable identifier for the turn. For liveboard-started synthetic first turns, this is the root node identifier. |\n| `timestamp_in_millis` | `Long` | Milliseconds since Unix epoch for the turn. |\n| `user_prompt` | `UserPrompt` | User-authored prompt that started the turn (message and attachments). `null` for liveboard-started synthetic first turns. |\n| `response_items` | `ConversationResponseItem[]` | Agent-side output produced in response to this turn. Empty array for in-progress turns. |\n\n#### UserPrompt fields\n\n| Field | Type | Description |\n| ------------- | ---------------------- | ---------------------------------------------------------------------------------------------------- |\n| `message` | `UserMessage` | User query that started the turn. `null` for liveboard-started synthetic first turns. |\n| `attachments` | `UserAttachmentItem[]` | Files or connector resources attached to the user message. Empty array when there are no attachments. |\n\n#### UserMessage fields\n\n| Field | Type | Description |\n| ------------ | -------- | --------------------------------------------- |\n| `message_id` | `String` | Unique identifier of the user-source message. |\n| `content` | `String` | Text body of the user query. |\n\n#### UserAttachmentItem fields\n\nDiscriminated by `type`. Only `\"file\"` or `\"resource\"` are valid values. Only the fields for the indicated variant are populated. See `ConversationResponseItem` below for the field definitions of the `file` and `resource` variants — `UserAttachmentItem` uses the same fields.\n\n#### ConversationResponseItem fields\n\nEvery item carries a `type` discriminator and these shared fields:\n\n| Field | Type | Description |\n| --------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ |\n| `type` | `String` | Discriminator. One of `\"text\"`, `\"tool_call\"`, `\"tool_result\"`, `\"answer\"`, `\"file\"`, `\"resource\"`, `\"search_datasets\"`. |\n| `timestamp_in_millis` | `Long` | Milliseconds since Unix epoch when this item was produced. |\n| `is_thinking` | `Boolean` | `true` when the item represents internal agent reasoning rather than user-facing output. Consumers may hide or collapse these. |\n| `step_title` | `String` | Human-readable label for the agent step producing this item (e.g. `\"Searching\"`, `\"Visualising\"`). |\n\nVariant-specific fields:\n\n- **`text`** — agent text output: `content` (String), `content_type` (`ContentMimeType` enum), `file_reference` (FileReference).\n- **`tool_call`** — agent invoked a tool: `tool_call_id` (String), `tool_name` (String), `arguments` (JSON object).\n- **`tool_result`** — result returned from a tool invocation: `tool_call_id`, `tool_name`, `content`, `content_type` (`ContentMimeType` enum), `success` (Boolean).\n- **`answer`** — slim reference to a saved answer: `answer_id` (String), `tool_call_id`, `tool_name`.\n- **`file`** — uploaded or generated files: `files` (`PublicFileInfo[]`).\n- **`resource`** — MCP connector resource: `title`, `uri`, `name`, `mime_type`, `description`, `size` (Int), `connector_id`, `connector_name`, `connector_slug`, `transport_type` (`TransportType` enum).\n- **`search_datasets`** — dataset discovery result: `text` (String), `data_sources` (`DataSourceInfo[]`).\n\nClients should switch on `type` and ignore unknown variants for forward-compatibility.\n\n#### content_type values\n\n`content_type` is the `ContentMimeType` enum. The following values are defined:\n\n| Value | Wire MIME | Meaning |\n| --------------------------- | --------------------------- | ---------------------------------------------------- |\n| `TEXT_PLAIN` | `text/plain` | Plain text. Default for `tool_result`. |\n| `TEXT_MARKDOWN` | `text/markdown` | Markdown. Default for `text`. |\n| `TEXT_X_MARKDOWN_WITH_CODE` | `text/x-markdown-with-code` | Markdown whose body starts with a fenced code block. |\n| `TEXT_HTML` | `text/html` | Raw HTML. |\n\n#### transport_type values\n\n`transport_type` is the `TransportType` enum used on the `resource` variant.\n\n| Value | Meaning |\n| ------------------ | --------------------------------------------- |\n| `STREAMABLE_HTTP` | Streamable HTTP transport (default for MCP). |\n| `SSE` | Server-sent events transport. |\n\n#### FileReference fields\n\n| Field | Type | Description |\n| ------------------------ | -------- | ------------------------------------------------------------ |\n| `file_id` | `String` | Unique identifier of the code-execution-generated file. |\n| `display_name` | `String` | Human-readable file name. |\n| `created_time_in_millis` | `Long` | Milliseconds since Unix epoch when the file was created. |\n\nCross-reference `file_id` against `code_execution_files` to retrieve full metadata including the `expired` flag before attempting a download.\n\n#### PublicFileInfo fields\n\n| Field | Type | Description |\n| ------------------------ | -------- | -------------------------------------------------------- |\n| `file_id` | `String` | Unique identifier of the file. |\n| `display_name` | `String` | Human-readable file name. |\n| `file_type` | `String` | File type such as `csv`, `pdf`, or `png`. |\n| `created_time_in_millis` | `Long` | Milliseconds since Unix epoch when the file was created. |\n| `size_bytes` | `Int` | File size in bytes. |\n\n#### CodeExecutionFileMetadata fields\n\nEach entry in the `code_execution_files` array contains:\n\n| Field | Type | Description |\n| ------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------- |\n| `file_id` | `String` | Unique identifier of the file. |\n| `display_name` | `String` | Human-readable file name. |\n| `file_type` | `String` | File type such as `csv`, `pdf`, or `png`. |\n| `created_time_in_millis` | `Long` | Milliseconds since Unix epoch when the file was created. |\n| `expired` | `Boolean` | When `true`, the underlying file is no longer retrievable from code-execution storage; UIs should disable download and preview. |\n\n#### Loading answer payloads\n\nEach `AnswerResponseItem` in the response contains an `answer_id` field. Pass this value as the `answer_identifier` parameter to `loadAnswer` to retrieve the full answer payload (TML tokens, visualization metadata) for that item.\n\n#### Example request\n\n```bash\nGET /api/rest/2.0/ai/agent/conversations/{conversation_identifier}/messages\n```\n\n#### Example response\n\n```json\n{\n \"messages\": [\n {\n \"message_id\": \"node_u_01\",\n \"timestamp_in_millis\": 1744000000000,\n \"user_prompt\": {\n \"message\": {\n \"message_id\": \"msg_u_01\",\n \"content\": \"Show me revenue by region as a chart.\"\n },\n \"attachments\": []\n },\n \"response_items\": [\n {\n \"type\": \"tool_call\",\n \"tool_call_id\": \"toolu_01ABC\",\n \"tool_name\": \"search_datasets\",\n \"step_title\": \"Searching datasets\",\n \"arguments\": { \"query\": \"revenue\" },\n \"timestamp_in_millis\": 1744000001000,\n \"is_thinking\": false\n },\n {\n \"type\": \"answer\",\n \"answer_id\": \"ans_01XYZ\",\n \"tool_call_id\": \"toolu_02DEF\",\n \"tool_name\": \"fetch_and_visualize\",\n \"step_title\": \"Visualising\",\n \"timestamp_in_millis\": 1744000004000,\n \"is_thinking\": false\n },\n {\n \"type\": \"text\",\n \"content\": \"Revenue is highest in APAC.\",\n \"content_type\": \"TEXT_MARKDOWN\",\n \"timestamp_in_millis\": 1744000005000,\n \"is_thinking\": false,\n \"step_title\": null,\n \"file_reference\": {\n \"file_id\": \"revenue_by_region.csv\",\n \"display_name\": \"revenue_by_region.csv\",\n \"created_time_in_millis\": 1744027200000\n }\n }\n ]\n }\n ],\n \"code_execution_files\": [\n {\n \"file_id\": \"revenue_by_region.csv\",\n \"display_name\": \"revenue_by_region.csv\",\n \"file_type\": \"csv\",\n \"created_time_in_millis\": 1744027200000,\n \"expired\": false\n }\n ]\n}\n```\n\n#### Example: liveboard-started conversation\n\nWhen a conversation is initiated from a saved liveboard visualization rather than a user query, the first turn is synthetic. `user_prompt` is `null`, and `response_items` contains a single `answer` item referencing the seed visualization.\n\n```json\n{\n \"messages\": [\n {\n \"message_id\": \"ROOT_NODE\",\n \"timestamp_in_millis\": 1743999000000,\n \"user_prompt\": null,\n \"response_items\": [\n {\n \"type\": \"answer\",\n \"answer_id\": \"lb_seed_01\",\n \"tool_call_id\": null,\n \"tool_name\": null,\n \"step_title\": null,\n \"timestamp_in_millis\": 1743999000000,\n \"is_thinking\": false\n }\n ]\n }\n ],\n \"code_execution_files\": []\n}\n```\n\nSubsequent turns follow the normal user-to-agent pattern.\n\n#### Error responses\n\n| Code | Description |\n| ---- | --------------------------------------------------------------------------------------------------------------------------- |\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks access to the specified conversation. |\n| 404 | Not Found — no conversation exists with the given identifier for the authenticated user. |\n\n> ###### Note:\n>\n> - Messages with an internal `SYSTEM` source are always dropped from the response.\n> - In-progress turns are still returned with an empty `response_items` array so clients can render the user message immediately.\n> - Do not assume every `tool_call` has a paired `tool_result` or `answer` — an interrupted conversation can leave a dangling call.\n> - Available from version 26.7.0.cl and later.\n> - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.7.0.cl" ], "parameters": [ { "in": "path", "name": "conversation_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the conversation to load." } ], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationMessageResponse" }, "examples": { "example": { "value": { "messages": [ { "message_id": "a1b2c3d4-0001-4e5f-8a6b-7c8d9e0f1a2b", "timestamp_in_millis": 1760198400000, "user_prompt": { "message": { "message_id": "a1b2c3d4-0001-4e5f-8a6b-7c8d9e0f1a2b", "content": "What were total sales by region last quarter?" }, "attachments": [ { "type": "file", "timestamp_in_millis": 1760198400000, "files": [ { "file_id": "b2c3d4e5-0002-4f6a-9b7c-8d9e0f1a2b3c", "display_name": "regional_targets.csv", "file_type": "text/csv", "created_time_in_millis": 1760198390000, "size_bytes": 2048 } ] }, { "type": "resource", "timestamp_in_millis": 1760198400000, "title": "Quarterly sales plan", "uri": "https://www.example.com/docs/sales-plan", "name": "sales-plan", "mime_type": "text/html", "description": "Sales plan document from a connected source", "size": 4096, "connector_id": "f6a7b8c9-0006-4d0e-9f1a-2b3c4d5e6f7a", "connector_name": "", "connector_slug": "", "transport_type": "STREAMABLE_HTTP" } ] }, "response_items": [ { "type": "search_datasets", "timestamp_in_millis": 1760198401000, "is_thinking": true, "step_title": "Finding data sources", "text": "Found 1 data source that matches the question.", "data_sources": [ { "data_source_identifier": "0e1f2a3b-4c5d-4e6f-9a7b-8c9d0e1f2a3b", "data_source_name": "Sales Model", "description": "Sales transactions by region and product", "confidence": 0.92, "reasoning": "The model contains sales amounts and a region column.", "header": { "display_name": "Sales Model", "guid": "0e1f2a3b-4c5d-4e6f-9a7b-8c9d0e1f2a3b", "description": "Sales transactions by region and product" }, "related_liveboard_visualizations": [ { "answer": { "header": { "id": "1f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c", "title": "Sales by region" } }, "pinboard_header": { "id": "2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d", "title": "Sales Overview" } } ], "related_answers": [ { "header": { "id": "3b4c5d6e-7f8a-4b9c-8d0e-1f2a3b4c5d6e", "title": "Quarterly sales by region" } } ], "related_spotter_queries": [ "sales by region last quarter" ] } ] }, { "type": "tool_call", "timestamp_in_millis": 1760198402000, "is_thinking": true, "step_title": "Querying data", "tool_call_id": "call_0001", "tool_name": "fetch_and_visualize_data", "arguments": { "query": "total sales by region last quarter", "data_source_identifier": "0e1f2a3b-4c5d-4e6f-9a7b-8c9d0e1f2a3b" } }, { "type": "tool_result", "timestamp_in_millis": 1760198404000, "is_thinking": true, "step_title": "Querying data", "tool_call_id": "call_0001", "tool_name": "fetch_and_visualize_data", "content": "Returned 4 rows.", "content_type": "TEXT_PLAIN", "success": true }, { "type": "answer", "timestamp_in_millis": 1760198405000, "is_thinking": false, "answer_id": "c3d4e5f6-0003-4a7b-8c8d-9e0f1a2b3c4d", "tool_call_id": "call_0001", "tool_name": "fetch_and_visualize_data" }, { "type": "file", "timestamp_in_millis": 1760198406000, "is_thinking": false, "files": [ { "file_id": "d4e5f6a7-0004-4b8c-9d9e-0f1a2b3c4d5e", "display_name": "sales_by_region.png", "file_type": "image/png", "created_time_in_millis": 1760198406000, "size_bytes": 51200 } ] }, { "type": "text", "timestamp_in_millis": 1760198407000, "is_thinking": false, "content": "Here are total sales by region for last quarter.", "content_type": "TEXT_MARKDOWN", "file_reference": { "file_id": "d4e5f6a7-0004-4b8c-9d9e-0f1a2b3c4d5e", "display_name": "sales_by_region.png", "created_time_in_millis": 1760198406000 } }, { "type": "resource", "timestamp_in_millis": 1760198408000, "is_thinking": false, "title": "Sales Overview", "uri": "https://www.example.com/liveboards/sales-overview", "name": "sales-overview", "mime_type": "text/html" } ] } ], "code_execution_files": [ { "file_id": "d4e5f6a7-0004-4b8c-9d9e-0f1a2b3c4d5e", "display_name": "sales_by_region.png", "file_type": "image/png", "created_time_in_millis": 1760198406000, "expired": false } ] } } } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationMessageResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/conversations": { "get": { "operationId": "getConversationList", "description": "\nRetrieves the list of saved agent conversations for the currently authenticated user.\nOnly conversations created with `enable_save_chat: true` are returned.
Version: 26.7.0.cl or later\n\nRetrieves a paginated list of saved agent conversations for the currently authenticated user. Only conversations that were created with `enable_save_chat: true` in `createAgentConversation` are returned.\n\nRequires `CAN_USE_SPOTTER` privilege.\n\n#### Usage guidelines\n\nThe request supports the following optional query parameters:\n\n- `limit`: maximum number of conversations to return. Use this together with `offset` for pagination.\n- `offset`: number of conversations to skip before returning results. Defaults to `0`.\n- `skip_empty`: when `true` (default), conversations with no messages are excluded from the results. Set to `false` to include empty conversations.\n\nIf the request is successful, the response includes a `conversations` array. Each entry contains:\n\n- `conversation_identifier`: the unique ID of the conversation, used as input to `sendAgentConversationMessage`, `updateConversation`, `deleteConversation`, `stopConversation`, and `loadAnswer`\n- `conversation_title`: the display name of the conversation\n- `created_at`: ISO 8601 timestamp of when the conversation was created\n- `updated_at`: ISO 8601 timestamp of the most recent update to the conversation\n- `data_source_identifiers`: list of unique IDs of the data sources associated with the conversation\n- `data_source_names`: array of `{ id, name }` objects for the data sources associated with the conversation\n- `is_pinned`: whether the current user has pinned this conversation. Pinned conversations are surfaced first in the list. Available from version 26.10.0.cl.\n- `analyst_id`: unique identifier of the Spotter Analyst the conversation is associated with, or `null` when the conversation is not associated with an analyst. Available from version 26.10.0.cl.\n\n#### Pagination\n\nUse `limit` and `offset` to page through large result sets:\n\n```\nGET /api/rest/2.0/ai/agent/conversations?limit=20&offset=0 → first page\nGET /api/rest/2.0/ai/agent/conversations?limit=20&offset=20 → second page\n```\n\n#### Pagination and `has_more`\n\nThe response includes a `has_more: Boolean` field. When `true`, there are additional conversations beyond the current page — increment `offset` by `limit` to fetch the next page. When `has_more` is `false`, the current page is the last. Note that `total_count` is not returned; use `has_more` to drive paging controls.\n\n#### Example response\n\n```json\n{\n \"conversations\": [\n {\n \"conversation_identifier\": \"abc123\",\n \"conversation_title\": \"Sales by Region Q1\",\n \"created_at\": \"2026-03-01T10:00:00Z\",\n \"updated_at\": \"2026-03-05T14:23:00Z\",\n \"data_source_identifiers\": [\"ds-001\"],\n \"data_source_names\": [{ \"id\": \"ds-001\", \"name\": \"Retail Sales\" }],\n \"is_pinned\": true\n }\n ],\n \"has_more\": false\n}\n```\n\n#### Error responses\n\n| Code | Description |\n|------|-------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege. |\n\n> ###### Note:\n>\n> - Only conversations created with `enable_save_chat: true` appear in this list. Conversations created with `enable_save_chat: false` (the default) are not persisted and cannot be retrieved.\n> - Available from version 26.7.0.cl and later.\n> - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.7.0.cl" ], "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "format": "int32", "default": 30 }, "description": "Maximum number of conversations to return. Used for pagination." }, { "in": "query", "name": "offset", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 }, "description": "Number of conversations to skip before returning results. Used for pagination." }, { "in": "query", "name": "skip_empty", "required": false, "schema": { "type": "boolean", "default": true }, "description": "When true, excludes conversations with no messages. Defaults to true." } ], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentConversationHistoryResponse" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentConversationHistoryResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/data-source-suggestions": { "post": { "operationId": "getDataSourceSuggestions", "description": "\nBeta Version: 10.15.0.cl or later\n\nSuggests the most relevant data sources for a given natural language query, ranked by confidence with LLM-generated reasoning.\n\nRequires `CAN_USE_SPOTTER` privilege and at least view-level access to the underlying metadata entities referenced in the response.\n\n#### Usage guidelines\n\nThe request must include:\n- `query`: the natural language question to find relevant data sources for\n\nIf the request is successful, the API returns a ranked list of suggested data sources, each containing:\n- `confidence`: a float score indicating the model's confidence in the relevance of the suggestion\n- `details`: metadata about the data source\n - `data_source_identifier`: the unique ID of the data source\n - `data_source_name`: the display name of the data source\n - `description`: a description of the data source\n- `reasoning`: LLM-generated rationale explaining why the data source was recommended\n\n#### Error responses\n\n| Code | Description |\n|------|--------------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the underlying metadata entities. |\n\n> ###### Note:\n> * This endpoint is currently in Beta. Breaking changes may be introduced before it is made Generally Available.\n> * This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "10.15.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDataSourceSuggestionsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eureka_DataSourceSuggestionResponse" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eureka_DataSourceSuggestionResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/instructions/get": { "post": { "operationId": "getNLInstructions", "description": "\nBeta Version: 10.15.0.cl or later\n\nRetrieves existing natural language (NL) instructions configured for a specific data model. These instructions guide the AI system in understanding data context and generating more accurate responses.\n\nRequires `CAN_USE_SPOTTER` privilege, at least view access on the data model, and a bearer token corresponding to the org where the data model exists.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `data_source_identifier`: the unique ID of the data model to retrieve instructions for\n\nIf the request is successful, the API returns:\n\n- `nl_instructions_info`: an array of instruction objects, each containing:\n - `instructions`: the configured text instructions for AI processing\n - `scope`: the scope of the instruction — currently only `GLOBAL` is supported\n\n#### Instructions scope\n\n- **GLOBAL**: Instructions that apply globally across the system on the given data-model (currently only global instructions are supported)\n\n#### Error responses\n\n| Code | Description |\n|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege, lacks view access on the data model, or the bearer token does not correspond to the org where the data model exists. |\n\n> ###### Note:\n>\n> - To use this API, the user needs at least view access on the data model, and must use the bearer token corresponding to the org where the data model exists.\n> - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> - Available from version 10.15.0.cl and later.\n> - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\n> - Use this API to review currently configured instructions before modifying them with `setNLInstructions`.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "10.15.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNLInstructionsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eureka_GetNLInstructionsResponse" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eureka_GetNLInstructionsResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/relevant-questions/": { "post": { "operationId": "getRelevantQuestions", "description": "\nBeta Version: 10.13.0.cl or later\n\nBreaks down a natural language query into a series of smaller analytical sub-questions, each mapped to a relevant data source.\n\nRequires `CAN_USE_SPOTTER` privilege and at least view-level access to the referenced metadata objects.\n\n#### Usage guidelines\n\nThe request must include:\n- `query`: the natural language question to decompose into analytical sub-questions\n- `metadata_context`: at least one of the following context identifiers to guide question generation:\n - `conversation_identifier` — an existing conversation session ID\n - `answer_identifiers` — a list of Answer GUIDs\n - `liveboard_identifiers` — a list of Liveboard GUIDs\n - `data_source_identifiers` — a list of data source GUIDs\n\nOptional parameters for refining the output:\n- `ai_context`: additional context to improve response quality\n - `content` — supplementary text or CSV data as string input\n - `instructions` — custom text instructions for the AI system\n- `limit_relevant_questions`: maximum number of questions to return (default: `5`)\n- `bypass_cache`: if `true`, forces fresh computation instead of returning cached results\n\nIf the request is successful, the API returns a list of relevant analytical questions, each containing:\n- `query`: the generated sub-question\n- `data_source_identifier`: the unique ID of the data source the question targets\n- `data_source_name`: the display name of the corresponding data source\n\n#### Error responses\n\n| Code | Description |\n|------|---------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view access to the referenced metadata objects. |\n\n> ###### Note:\n> * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "10.13.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRelevantQuestionsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eureka_GetRelevantQuestionsResponse" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eureka_GetRelevantQuestionsResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/conversations/{conversation_identifier}/get-shared-content": { "get": { "operationId": "getSharedContent", "description": "\nReturns the full read-only view of a shared conversation, including ordered\nmessages and data source metadata. Accessible by the conversation owner and\nany principal (user or group) that has been granted access.\nRequires `CAN_USE_SPOTTER` privilege.
Version: 26.9.0.cl or later\n\nReturns the full read-only view of a shared conversation, including ordered messages and data source metadata. Accessible by the conversation owner and any principal (user or group) that has been granted access via `shareConversation`.\n\nUse this endpoint to render a shared conversation in a UI or to retrieve its content for post-processing. The full answer payload is not embedded in messages — fetch it separately via `loadAnswer` using the `shared_conversation_id` from this response as the `conversation_identifier` parameter, along with the `answer_id` from each `answer` response item.\n\n> **Important**: `shared_conversation_id` is not the same as `conversation_id`. It identifies the shared snapshot, which is a separate internal object from the source conversation. You must use the `shared_conversation_id` value — not `conversation_id` — as the `conversation_identifier` parameter when calling `loadAnswer` to hydrate answers from a shared view.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `conversation_identifier` _(query parameter)_: the unique ID of the source conversation.\n\n#### Response fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `conversation_id` | `String` | Echoes the request parameter. |\n| `shared_conversation_id` | `String` | Identifier for the shared snapshot. **This is not the same as `conversation_id`.** Pass this value as the `conversation_identifier` parameter in `loadAnswer` calls. It changes each time the snapshot is refreshed via `shareConversation` with `refresh_shared_content: true` — re-fetch this response to get the current value before calling `loadAnswer`. |\n| `conversation_title` | `String` | Display title of the conversation. `null` if no title was set. |\n| `creator_user_id` | `String` | Identifier of the user who created the conversation and shared it. This is the original creator, not the caller retrieving the shared content. |\n| `data_sources` | `DataSourceEntry[]` | Data sources used by the conversation, each with an `id` and display `name`. |\n| `analyst_ids` | `String[]` | Identifiers of the AI analysts the conversation ran against. An analyst is a purpose-built agent configured over a set of data sources, with its own instructions and access rules. Empty when the conversation is not associated with any analyst. |\n| `messages` | `ConversationMessage[]` | Ordered conversation messages, oldest to newest. Same structure as returned by `getConversation`. Empty when the conversation has no messages. |\n| `code_execution_files` | `CodeExecutionFileMetadata[]` | Sanitized metadata for files generated by the code-execution tool. Empty when there are none. |\n\n#### DataSourceEntry fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `String` | Unique identifier of the data source. |\n| `name` | `String` | Display name of the data source. |\n\n#### CodeExecutionFileMetadata fields\n\nEach entry in the `code_execution_files` array contains:\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `file_id` | `String` | Unique identifier of the file. |\n| `display_name` | `String` | Human-readable file name. |\n| `file_type` | `String` | File type such as `csv`, `pdf`, or `png`. |\n| `created_time_in_millis` | `Long` | Milliseconds since Unix epoch when the file was created. |\n| `expired` | `Boolean` | When `true`, the underlying file is no longer retrievable from code-execution storage; UIs should disable download and preview. |\n\n#### Loading answer payloads\n\nEach `answer` response item in `messages[].response_items` contains an `answer_id` field. To retrieve the full answer payload (TML tokens, visualization metadata, chart config), call `loadAnswer` with:\n\n- `conversation_identifier`: the `shared_conversation_id` from **this** response (not `conversation_id`)\n- `answer_identifier`: the `answer_id` from the `answer` item\n\nIf the snapshot has been refreshed since you last called `getSharedContent`, the `shared_conversation_id` will have changed. Always use the `shared_conversation_id` from the most recent `getSharedContent` response; stale values return 404.\n\n#### Example request\n\n```bash\nGET /api/rest/2.0/ai/agent/conversations/{conversation_identifier}/get-shared-content\n```\n\n#### Example response\n\n```json\n{\n \"conversation_id\": \"conv-abc-123\",\n \"shared_conversation_id\": \"snap-xyz-456\",\n \"conversation_title\": \"Sales by Region Q1\",\n \"creator_user_id\": \"5d3e6cc7-2f4a-4b0e-9a1c-8f2b6d4e7a10\",\n \"data_sources\": [{ \"id\": \"ds-001\", \"name\": \"Retail Sales\" }],\n \"analyst_ids\": [\"spot-7f2a\"],\n \"messages\": [\n {\n \"message_id\": \"node-u-01\",\n \"timestamp_in_millis\": 1744000000000,\n \"user_prompt\": {\n \"message\": {\n \"message_id\": \"msg-u-01\",\n \"content\": \"Show me revenue by region.\"\n },\n \"attachments\": []\n },\n \"response_items\": [\n {\n \"type\": \"tool_call\",\n \"tool_call_id\": \"toolu-01\",\n \"tool_name\": \"search_datasets\",\n \"step_title\": \"Searching datasets\",\n \"arguments\": { \"query\": \"revenue by region\" },\n \"timestamp_in_millis\": 1744000001000,\n \"is_thinking\": false\n },\n {\n \"type\": \"answer\",\n \"answer_id\": \"ans-01\",\n \"tool_call_id\": \"toolu-02\",\n \"tool_name\": \"fetch_and_visualize\",\n \"step_title\": \"Visualizing\",\n \"timestamp_in_millis\": 1744000004000,\n \"is_thinking\": false\n },\n {\n \"type\": \"text\",\n \"content\": \"Revenue is highest in APAC.\",\n \"content_type\": \"TEXT_MARKDOWN\",\n \"timestamp_in_millis\": 1744000005000,\n \"is_thinking\": false,\n \"step_title\": null,\n \"file_reference\": null\n }\n ]\n }\n ],\n \"code_execution_files\": [\n {\n \"file_id\": \"revenue_by_region.csv\",\n \"display_name\": \"revenue_by_region.csv\",\n \"file_type\": \"csv\",\n \"created_time_in_millis\": 1744027200000,\n \"expired\": false\n }\n ]\n}\n```\n\nFor the `ConversationMessage` field structure, see `getConversation`.\n\n#### Error responses\n\n| Code | Description |\n| --- | --- |\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the caller is neither the conversation owner nor a principal with access, or does not have `CAN_USE_SPOTTER` privilege. |\n| 404 | Not Found — no active shared view exists for the given conversation identifier. |\n\n> ###### Note:\n>\n> - The shared view is a point-in-time copy of the conversation. It may not reflect edits made after sharing. Check `is_shared_content_outdated` via `getShareInfo` and use `shareConversation` with `refresh_shared_content: true` to update.\n> - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\nVersion: 26.9.0.cl or later\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.9.0.cl" ], "parameters": [ { "in": "path", "name": "conversation_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the source conversation." } ], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedConversationResponse" }, "examples": { "example_1": { "summary": "Shared conversation with one message and an answer", "value": { "conversation_id": "conv-abc-123", "shared_conversation_id": "snap-xyz-456", "conversation_title": "Sales by Region Q1", "creator_user_id": "5d3e6cc7-2f4a-4b0e-9a1c-8f2b6d4e7a10", "data_sources": [ { "id": "ds-001", "name": "Retail Sales" } ], "analyst_ids": [ "spot-7f2a" ], "messages": [ { "message_id": "node-u-01", "timestamp_in_millis": 1744000000000, "user_prompt": { "message": { "message_id": "msg-u-01", "content": "Show me revenue by region." }, "attachments": [] }, "response_items": [ { "type": "answer", "answer_id": "ans-01", "tool_call_id": "toolu-01", "tool_name": "fetch_and_visualize", "step_title": "Visualizing", "timestamp_in_millis": 1744000004000, "is_thinking": false }, { "type": "text", "content": "Revenue is highest in APAC at $4.2M.", "content_type": "TEXT_MARKDOWN", "timestamp_in_millis": 1744000005000, "is_thinking": false, "step_title": null, "file_reference": null } ] } ], "code_execution_files": [ { "file_id": "revenue_by_region.csv", "display_name": "revenue_by_region.csv", "file_type": "csv", "created_time_in_millis": 1744027200000, "expired": false } ] } } } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedConversationResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/conversations/{conversation_identifier}/get-share-info": { "get": { "operationId": "getShareInfo", "description": "\nReturns the current share state for a conversation the caller owns: whether\nthe shared view is outdated relative to the latest conversation content, and\nthe list of principals that currently have access.\nRequires `CAN_USE_SPOTTER` privilege and ownership of the specified conversation.
Version: 26.9.0.cl or later\n\nReturns the current share state for a conversation the caller owns: whether the shared view reflects the latest conversation content, and the list of principals that currently have access.\n\nUse this endpoint to render a share management UI, audit who has access to a conversation, or determine whether the shared view needs to be refreshed before sending a link.\n\nRequires ownership of the specified conversation.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `conversation_identifier` _(query parameter)_: the unique ID of the conversation, as returned by `createAgentConversation` or `getConversationList`.\n\n#### Response fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `conversation_id` | `String` | Echoes the request parameter. |\n| `is_shared_content_outdated` | `Boolean` | `true` when the shared view was generated before the last edit to the conversation and does not reflect the latest content. `false` when the shared view is current. `null` when the conversation has never been shared. |\n| `principals` | `ConversationPrincipalInfo[]` | List of principals with access. Empty when no access has been granted. The conversation owner is never included. |\n\n#### ConversationPrincipalInfo fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `id` | `String` | Unique identifier of the user or group. |\n| `type` | `Principals` | `USER` for individual users, `USER_GROUP` for groups. |\n| `display_name` | `String` | Display name as shown in the ThoughtSpot UI. |\n| `name` | `String` | Internal name of the user or group. |\n| `permission` | `String` | Access level. Always `READ_ONLY` for shared conversations. |\n\n#### Example request\n\n```bash\nGET /api/rest/2.0/ai/agent/conversations/{conversation_identifier}/get-share-info\n```\n\n#### Example response — conversation shared and current\n\n```json\n{\n \"conversation_id\": \"conv-abc-123\",\n \"is_shared_content_outdated\": false,\n \"principals\": [\n {\n \"id\": \"user-001\",\n \"type\": \"USER\",\n \"display_name\": \"Alice Example\",\n \"name\": \"alice.example\",\n \"permission\": \"READ_ONLY\"\n },\n {\n \"id\": \"group-001\",\n \"type\": \"USER_GROUP\",\n \"display_name\": \"Sales Team\",\n \"name\": \"sales-team\",\n \"permission\": \"READ_ONLY\"\n }\n ]\n}\n```\n\n#### Example response — conversation never shared\n\n```json\n{\n \"conversation_id\": \"conv-abc-123\",\n \"is_shared_content_outdated\": null,\n \"principals\": []\n}\n```\n\n#### Example response — shared view outdated\n\n```json\n{\n \"conversation_id\": \"conv-abc-123\",\n \"is_shared_content_outdated\": true,\n \"principals\": [\n {\n \"id\": \"user-001\",\n \"type\": \"USER\",\n \"display_name\": \"Alice Example\",\n \"name\": \"alice.example\",\n \"permission\": \"READ_ONLY\"\n }\n ]\n}\n```\n\nWhen `is_shared_content_outdated` is `true`, call `shareConversation` with `refresh_shared_content: true` to update the shared view with the latest conversation content.\n\n#### Error responses\n\n| Code | Description |\n| --- | --- |\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the caller does not own the specified conversation, or does not have `CAN_USE_SPOTTER` privilege. |\n| 404 | Not Found — no conversation exists with the given identifier for the authenticated user. |\n\n> ###### Note:\n>\n> - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\nVersion: 26.9.0.cl or later\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.9.0.cl" ], "parameters": [ { "in": "path", "name": "conversation_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the conversation." } ], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationShareStatusResponse" }, "examples": { "example_1": { "summary": "Conversation shared with two principals, content is current", "value": { "conversation_id": "conv-abc-123", "is_shared_content_outdated": false, "principals": [ { "id": "user-001", "type": "USER", "display_name": "Alice Example", "name": "alice.example", "permission": "READ_ONLY" }, { "id": "group-001", "type": "USER_GROUP", "display_name": "Sales Team", "name": "sales-team", "permission": "READ_ONLY" } ] } }, "example_2": { "summary": "Conversation never shared", "value": { "conversation_id": "conv-abc-123", "is_shared_content_outdated": null, "principals": [] } }, "example_3": { "summary": "Shared view is outdated — conversation was edited after sharing", "value": { "conversation_id": "conv-abc-123", "is_shared_content_outdated": true, "principals": [ { "id": "user-001", "type": "USER", "display_name": "Alice Example", "name": "alice.example", "permission": "READ_ONLY" } ] } } } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationShareStatusResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/memory/import": { "post": { "operationId": "importMemory", "description": "\nImports memory entries (rules, recipes, and always-apply rules) from\na YAML payload, typically a payload produced by `exportMemory` and\nedited locally. The imported entries replace the existing memory for\nthe data-models referenced in the payload.\n`dry_run` is required. Pass `true` first to validate the payload and\nreview the preview counts and any row-level failures without making\nchanges, then re-run with `dry_run = false` to apply the import. An\nimport is not applied if any row fails validation.\nRequires Spotter access (use/manage) and either edit or memory\naccess on corresponding data model sources.
Beta Version: 26.8.0.cl or later\n\nThis API allows users to import data-model memories using a given yaml file. This yaml file can be obtained from the export memory API in source env and can be modified and used as input to the import API in target env.\n\nThis API enables customers to migrate memories from a source env to a target env. This improves memory adoption for Spotter by giving the users a chance to develop their memories in one env and replicate the same in another env.\n\n#### Usage guidelines\n\nTo import memory, the request must include:\n- `content`: The full serialized memory payload to import (YAML). Typically the `content` value returned by the `exportMemory` API, edited locally and re-submitted. The payload itself identifies which data-models the memory applies to, so no separate identifier list is required.\n- `dry_run`: Required. When `true`, validate the payload and return preview counts without writing anything; when `false`, apply the import. Always run with `dry_run = true` first, then re-run with `dry_run = false` once you are satisfied with the preview.\n\nThe import replaces the existing global memories on the data-models referenced in the payload with the entries supplied in the payload.\n\nThe API returns a response object with:\n- `status`: The terminal status of the import (`SUCCESS`, `VALIDATION_FAILED`, or `FAILED`).\n- `summary`: Per `(memory_type, source)` counts. In a dry run the `deleted_record_count`/`inserted_record_count` are previews; in a real import they are actuals. On `VALIDATION_FAILED`, `summary` is `null` when validation fails before any item is processed (e.g. an unresolved or inaccessible data-model source) and an empty list otherwise — treat both as \"no counts available\".\n- `validation_failures`: Per-item validation failures, each with `line_number`, `reason`, `field_name`, and `message` for click-to-locate and inline highlighting.\n- `diagnostics`: Groups of diagnostic messages, each with a `sub_status` (`WARNING`, `FAILURE`, `ROLLED_BACK`, or `UNKNOWN`) and a `messages` list. This is the single channel for both non-fatal warnings (under `WARNING`, e.g. when some older memory entries could not be fully cleaned up) and fatal causes (e.g. the failure reason under `FAILURE`, or a `ROLLED_BACK` group when new entries were undone).\n- `operation_id`: A server-generated identifier for this import operation; include it when contacting support to help correlate server-side logs. Populated once the server registers the import operation; `null` when the request fails earlier (e.g. while parsing the payload or resolving its data-model sources).\n\n#### File format\n\nThe payload is a YAML document with a single top-level `memories` key holding a list of memory items. Each item is self-contained: a `type`, a typed `content` block, a `datamodel_sources` list, and optional `tags`. Typically you don't hand-author this file — you obtain it from `exportMemory`, edit it, and submit it back through `importMemory`.\n\n```yaml\nmemories:\n- type: RULE\n content:\n rule_definition: \"Always filter revenue to closed-won deals.\"\n datamodel_sources:\n - guid: 11111111-1111-1111-1111-111111111111\n obj_id: sales_data_model\n tags:\n - finance\n- type: RULE\n content:\n rule_definition: \"Exclude internal test accounts from all results.\"\n datamodel_sources:\n - obj_id: sales_data_model\n- type: RECIPE\n content:\n user_query: \"top accounts by revenue\"\n recipe: |\n {\"steps\": [...serialized recipe blob...]}\n datamodel_sources:\n - obj_id: sales_data_model\n- type: RECIPE\n content:\n user_query: \"monthly new customer count\"\n recipe: |\n {\"steps\": [...serialized recipe blob...]}\n datamodel_sources:\n - obj_id: sales_data_model\n- type: ALWAYS_APPLY_RULES\n content:\n rules:\n - \"Never show internal test accounts.\"\n - \"Round currency to whole dollars.\"\n datamodel_sources:\n - guid: 22222222-2222-2222-2222-222222222222\n```\n\nA file can contain multiple `RULE` and multiple `RECIPE` items for a data-model, but at most one `ALWAYS_APPLY_RULES` item per data-model.\n\n##### Memory item fields\n\n| Field | Required | Type | Description |\n|-------|----------|------|-------------|\n| `type` | Yes | String enum | One of `RULE`, `RECIPE`, or `ALWAYS_APPLY_RULES`. |\n| `content` | Yes | Mapping | Type-specific content block (see below). |\n| `datamodel_sources` | Yes | Non-empty list | The data-model(s) the memory attaches to. |\n| `tags` | No | List of strings | Free-form labels. |\n\n##### Memory types and content\n\n| `type` | Content fields | Notes |\n|--------|----------------|-------|\n| `RULE` | `rule_definition` — required, non-empty string | A single semantic rule. |\n| `RECIPE` | `recipe` and `user_query` — both required, non-empty strings | `recipe` is an opaque serialized blob; `user_query` is the natural-language query it answers. |\n| `ALWAYS_APPLY_RULES` | `rules` — required, non-empty list of non-empty strings | Data-model-wide always-apply rules. At most one `ALWAYS_APPLY_RULES` item per data-model. |\n\n##### Identifying data-models (`datamodel_sources`)\n\nEach item must list at least one source. Each entry identifies a data-model by at least one of:\n- `guid` — the data-model GUID.\n- `obj_id` — a stable object ID, resolved to a GUID server-side.\n\nIf both are supplied, `obj_id` takes precedence and `guid` is ignored entirely; `guid` takes effect only when `obj_id` is absent. Exported files populate `guid` and, if present, `obj_id` as well.\n\n> ⚠️ **Cross-environment import:** When `obj_id` is present it is\n> authoritative — the accompanying `guid` is **not** used as a fallback.\n> If an `obj_id` does not exist in the target environment, that item\n> fails with `UNRESOLVED_SOURCE`. Remove or correct stale `obj_id`\n> values before importing across environments.\n\n#### Validations reference\n\nThe payload is fully validated before anything is written. This applies to `dry_run = true` and `dry_run = false` alike: if any item fails validation, the entire import is rejected — no partial writes — and all failures are returned together so you can fix them in one pass.\n\n##### Limits\n\nDefault limits (may be adjusted in future if the need arises):\n\n| Limit | Default |\n|-------|---------|\n| Uploaded file size | 10 MiB |\n| Total memory items | 10,000 |\n| `rule_definition` length | 1,000 characters |\n| `user_query` length | 1,000 characters |\n| `recipe` length | 2,000 characters |\n| `rules` combined length (`ALWAYS_APPLY_RULES`) | 2,000 characters |\n| Tags per item | 10 |\n| Characters per tag | 50 |\n\nThe `rules` limit in `ALWAYS_APPLY_RULES` is a combined budget across all entries in the list, not per entry.\n\n##### Structural rules\n\n- The document must be a mapping with a `memories` key whose value is a list.\n- Unknown keys — at the top level, within an item, or under `content` — are rejected.\n- Each item's `type` must be one of the three supported values, and `content` must match that type's shape.\n- Null, empty-string, or wrong-typed values in a required field are treated as missing.\n- Non-string or empty `tags` entries are dropped silently; certain tags reserved for internal use are stripped automatically before the item is stored.\n\n##### Cross-item rules\n\n- A data-model referenced by more than one `ALWAYS_APPLY_RULES` item is rejected — combine them into a single item's `rules` list.\n\n##### Failure reasons\n\nEach entry in `validation_failures` carries one of:\n\n| Reason | Meaning |\n|--------|---------|\n| `SCHEMA` | YAML structure is invalid or unsupported. |\n| `VALIDATION` | A required field is missing/empty, a count exceeds a limit, or a GUID is malformed. |\n| `CHAR_LIMIT` | A content field or tag exceeds its size limit. |\n| `UNRESOLVED_SOURCE` | A `guid` or `obj_id` could not be resolved to an existing data-model. |\n| `ACCESS_DENIED` | The caller lacks sufficient access on the referenced data-model. |\n\n#### Dry run\n\n`dry_run` is required and has no default, so the import is always a deliberate two-step flow:\n\n1. **First, call with `dry_run = true`.** This validates the payload and previews what would happen — the counts in `summary` and any `validation_failures` — without writing anything.\n2. **Then, after reviewing a clean preview, call again with `dry_run = false`** (same `content`). This applies the import. It refuses to write when any item fails validation, so fix the reported `validation_failures` and resubmit.\n\n> ###### Important:\n> Never call `dry_run = false` without first inspecting a `dry_run = true` preview. A real import deletes and replaces existing global memories on the referenced data-models.\n\n#### Error responses\n\n| Code | Description |\n|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have the necessary Spotter permissions, or the bearer token does not correspond to the data-model's org. Per-data-model access failures do not use this code — they surface as `ACCESS_DENIED` validation failures with HTTP `200` (see Logical failures below). |\n\n#### Logical failures\n\nValidation and write failures are not returned in the error envelope. The call returns `200` with a terminal `status` of `VALIDATION_FAILED` or `FAILED`, and the details live in `validation_failures` / `diagnostics`:\n\n- **VALIDATION_FAILED** — one or more items failed schema/semantic validation; nothing was written. Inspect `validation_failures`, fix the items, and resubmit.\n- **FAILED** — the import did not complete. Inspect `diagnostics`: a `ROLLED_BACK` group means writing the new entries failed and any entries written before the failure were undone (existing memory is intact, no destructive change), while a `FAILURE` group carries another non-validation cause.\n\nSample `VALIDATION_FAILED` responses (HTTP 200):\n\n**Invalid data-model (unresolved source):**\n\n```json\n{\n \"status\": \"VALIDATION_FAILED\",\n \"summary\": null,\n \"validation_failures\": [\n {\n \"line_number\": 2,\n \"reason\": \"UNRESOLVED_SOURCE\",\n \"field_name\": \"datamodel_sources[0].guid\",\n \"message\": \"unknown datamodel guid: 55555555-5555-5555-5555-555555555555\"\n }\n ],\n \"diagnostics\": [\n {\n \"sub_status\": \"FAILURE\",\n \"messages\": [\n \"unknown datamodel guid: 55555555-5555-5555-5555-555555555555\"\n ]\n }\n ],\n \"operation_id\": null\n}\n```\n\n**Inaccessible data-models:**\n\n```json\n{\n \"status\": \"VALIDATION_FAILED\",\n \"summary\": null,\n \"validation_failures\": [\n {\n \"line_number\": 2,\n \"reason\": \"ACCESS_DENIED\",\n \"field_name\": \"datamodel_sources[0]\",\n \"message\": \"Insufficient permissions on datamodel '44444444-4444-4444-4444-444444444444'\"\n },\n {\n \"line_number\": 8,\n \"reason\": \"ACCESS_DENIED\",\n \"field_name\": \"datamodel_sources[0]\",\n \"message\": \"Insufficient permissions on datamodel '33333333-3333-3333-3333-333333333333'\"\n }\n ],\n \"diagnostics\": [\n {\n \"sub_status\": \"FAILURE\",\n \"messages\": [\n \"Memory import validation failed with 2 error(s): Insufficient permissions on datamodel '44444444-4444-4444-4444-444444444444'; Insufficient permissions on datamodel '33333333-3333-3333-3333-333333333333'\"\n ]\n }\n ],\n \"operation_id\": null\n}\n```\n\n**Character-limit validations:**\n\n```json\n{\n \"status\": \"VALIDATION_FAILED\",\n \"summary\": [],\n \"validation_failures\": [\n {\n \"line_number\": 3,\n \"reason\": \"CHAR_LIMIT\",\n \"field_name\": \"content.rule_definition\",\n \"message\": \"content.rule_definition is 1073 characters; max allowed is 1000\"\n },\n {\n \"line_number\": 49,\n \"reason\": \"CHAR_LIMIT\",\n \"field_name\": \"content.user_query\",\n \"message\": \"content.user_query is 1150 characters; max allowed is 1000\"\n },\n {\n \"line_number\": 49,\n \"reason\": \"CHAR_LIMIT\",\n \"field_name\": \"content.recipe\",\n \"message\": \"content.recipe is 3574 characters; max allowed is 2000\"\n }\n ],\n \"diagnostics\": [\n {\n \"sub_status\": \"FAILURE\",\n \"messages\": [\n \"Validation failures present; fix them and re-run to see the DRY_RUN preview.\"\n ]\n }\n ],\n \"operation_id\": \"66666666-6666-6666-6666-666666666666\"\n}\n```\n\n> ###### Note:\n> - To use this API, the user needs Spotter access (use/manage) and either edit or memory access on the data-model and they must use corresponding org related bearerToken where the data-model exists.\n> - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> - Available from version 26.8.0.cl and later.\n> - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.8.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportMemoryRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportMemoryResponse" }, "examples": { "example_1": { "summary": "Successful dry-run preview", "value": { "status": "SUCCESS", "summary": [ { "memory_type": "RULES", "source": { "identifier": "33333333-3333-3333-3333-333333333333", "type": "DATA_MODEL" }, "existing_record_count": 3, "deleted_record_count": 3, "inserted_record_count": 2, "failed_record_count": 0 }, { "memory_type": "RECIPES", "source": { "identifier": "33333333-3333-3333-3333-333333333333", "type": "DATA_MODEL" }, "existing_record_count": 7, "deleted_record_count": 7, "inserted_record_count": 4, "failed_record_count": 0 }, { "memory_type": "ALWAYS_APPLY_RULES", "source": { "identifier": "33333333-3333-3333-3333-333333333333", "type": "DATA_MODEL" }, "existing_record_count": 0, "deleted_record_count": 0, "inserted_record_count": 1, "failed_record_count": 0 } ], "validation_failures": [], "diagnostics": [], "operation_id": "77777777-7777-7777-7777-777777777777" } }, "example_2": { "summary": "Successful import (dry_run=false)", "value": { "status": "SUCCESS", "summary": [ { "memory_type": "RULES", "source": { "identifier": "33333333-3333-3333-3333-333333333333", "type": "DATA_MODEL" }, "existing_record_count": 3, "deleted_record_count": 3, "inserted_record_count": 2, "failed_record_count": 0 }, { "memory_type": "RECIPES", "source": { "identifier": "33333333-3333-3333-3333-333333333333", "type": "DATA_MODEL" }, "existing_record_count": 7, "deleted_record_count": 7, "inserted_record_count": 4, "failed_record_count": 0 }, { "memory_type": "ALWAYS_APPLY_RULES", "source": { "identifier": "33333333-3333-3333-3333-333333333333", "type": "DATA_MODEL" }, "existing_record_count": 0, "deleted_record_count": 0, "inserted_record_count": 1, "failed_record_count": 0 } ], "validation_failures": [], "diagnostics": [], "operation_id": "88888888-8888-8888-8888-888888888888" } } } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportMemoryResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/conversations/{conversation_identifier}/answers/{answer_identifier}/details": { "get": { "operationId": "loadAnswer", "description": "\nLoads the full answer payload for a specific answer item in an agent\nconversation. Returns structured answer data including the TML query, token\nbreakdown, visualization metadata, and agent context state.\nPass the `answer_id` from an `AnswerResponseItem` in the `getConversation`\nresponse as the `answer_identifier` parameter.\nRequires `CAN_USE_SPOTTER` privilege and access to the specified conversation.
Version: 26.7.0.cl or later\n\nLoads the answer details for a specific answer item in an agent conversation. Returns structured answer data including the TML token list, visualization metadata, and agent context state. Use this endpoint to retrieve the full answer representation for an answer item — for example, to re-render a chart, export a query, or inspect the generated TML.\n\nRequires `CAN_USE_SPOTTER` privilege and access to the specified conversation.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `conversation_identifier` *(path parameter)*: the unique ID of the conversation, as returned by `createAgentConversation`\n- `answer_identifier` *(path parameter)*: the `answer_id` field from an `AnswerResponseItem` in the `getConversation` response\n\nIf the request is successful, the response contains an `answer` object with the following fields:\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `title` | `String` | Display title of the generated answer (e.g., `\"sales by month\"`). |\n| `description` | `String` | Optional description of the answer. |\n| `session_identifier` | `String` | Unique identifier of the session in which this answer was generated. |\n| `generation_number` | `Int` | Generation sequence number of this answer within the session. |\n| `tokens` | `[String]` | Ordered list of TML token strings that make up the answer query (e.g., `[\"[sales]\", \"[date].'monthly'\"]`). |\n| `visualization_type` | `VizType` | Suggested visualization type: `Chart`, `Table`, or `Undefined`. `null` if no suggestion is available. |\n| `formulas` | `[String]` | List of formula names referenced in the answer. Empty if none are used. |\n| `parameters` | `[String]` | List of parameter names applied to the answer. Empty if none are used. |\n| `sub_queries` | `[JSON]` | List of sub-query objects used in the answer. Empty if none are present. |\n| `ac_state` | `ACState` | Agent context state, including `transaction_identifier` and `generation_number`, used to correlate this answer with a specific agent turn. |\n\n#### ACState fields\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `transaction_identifier` | `String` | Unique identifier of the agent transaction that produced this answer. |\n| `generation_number` | `Int` | Generation number within the transaction. |\n\n#### Example request\n\n```bash\nGET /api/rest/2.0/ai/agent/conversations/{conversation_identifier}/answers/{answer_identifier}/details\n```\n\n#### Example response\n\n```json\n{\n \"answer\": {\n \"title\": \"sales by month\",\n \"description\": \"\",\n \"session_identifier\": \"7b00b801-73f4-4639-af5e-e775584ceba6\",\n \"generation_number\": 1,\n \"tokens\": [\"[sales]\", \"[date].'monthly'\"],\n \"visualization_type\": null,\n \"formulas\": [],\n \"parameters\": [],\n \"sub_queries\": [],\n \"ac_state\": {\n \"transaction_identifier\": \"7f6c9948-b4c7-4098-bb1f-6c67bc0e5699\",\n \"generation_number\": 1\n }\n }\n}\n```\n\n#### Typical usage scenario\n\n1. Call `getConversation` to retrieve the full conversation history.\n2. Locate an `AnswerResponseItem` in `response_items` — note its `answer_id` field.\n3. Call `loadAnswer` with the `conversation_identifier` and `answer_id` as `answer_identifier`.\n4. The returned `tokens` array can be used to open the answer in the ThoughtSpot search interface or rendered as pill chips in the UI.\n\n#### Error responses\n\n| Code | Description |\n|------|-------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks access to the specified conversation. |\n| 404 | Not Found — no conversation or message exists with the given identifiers for the authenticated user. |\n| 422 | Unprocessable Entity — the message does not contain an answer of the expected type. |\n\n> ###### Note:\n>\n> - This endpoint only loads answer-type messages. Other message types are not supported.\n> - `visualization_type` may be `null` if the agent did not produce a visualization suggestion for this answer.\n> - `formulas`, `parameters`, and `sub_queries` are returned as empty arrays when not applicable — they are never `null`.\n> - Available from version 26.7.0.cl and later.\n> - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.7.0.cl" ], "parameters": [ { "in": "path", "name": "conversation_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the conversation." }, { "in": "path", "name": "answer_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the answer to load. Use the `answer_id` field from an\n`AnswerResponseItem` returned by `getConversation`." } ], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadAnswerResponse" }, "examples": { "example": { "value": { "answer": { "title": "Total sales by region last quarter", "description": "Total sales for each region in the last quarter", "session_identifier": "e5f6a7b8-0005-4c9d-8e0f-1a2b3c4d5e6f", "generation_number": 2, "ac_state": { "transaction_identifier": "a7b8c9d0-1e2f-4a3b-8c4d-5e6f7a8b9c0d", "generation_number": 2 }, "tokens": [ "[sales]", "[region]", "[date].'last quarter'" ], "visualization_type": "CHART", "formulas": [], "parameters": [], "sub_queries": [ { "tokens": "[sales] [region] [date].'last quarter'", "formulas": [ { "name": "Profit Margin", "expression": "sum ( [profit] ) / sum ( [sales] )", "formula_type": "AI_GENERATED", "is_auto_generated": true, "columns_used": [ "profit", "sales" ] } ] } ] } } } } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadAnswerResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/analytical-questions": { "post": { "operationId": "queryGetDecomposedQuery", "description": "\nBeta Version: 10.7.0.cl or later\n\nVersion: 10.7.0.cl or later\n\n**Deprecated** — Use `getRelevantQuestions` instead (available from 10.13.0.cl).\n\nBreaks down a topical or goal-oriented natural language question into smaller, actionable analytical sub-questions, each mapped to a relevant data source for independent execution.\n\nRequires `CAN_USE_SPOTTER` privilege and at least view-level access to the referenced metadata objects.\n\n#### Usage guidelines\n\nThe request accepts the following parameters:\n\n- `nlsRequest`: contains the user `query` to decompose, along with optional `instructions` and `bypassCache` flag\n- `worksheetIds`: list of data source identifiers to scope the decomposition\n- `answerIds`: list of Answer GUIDs whose data guides the response\n- `liveboardIds`: list of Liveboard GUIDs whose data guides the response\n- `conversationId`: an existing conversation session ID for context continuity\n- `content`: supplementary text or CSV data to improve response quality\n- `maxDecomposedQueries`: maximum number of sub-questions to return (default: `5`)\n\nIf the request is successful, the API returns a `decomposedQueryResponse` containing a list of `decomposedQueries`, each with:\n- `query`: the generated analytical sub-question\n- `worksheetId`: the unique ID of the data source the question targets\n- `worksheetName`: the display name of the corresponding data source\n\n#### Error responses\n\n| Code | Description |\n|------|---------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view access to the referenced metadata objects. |\n\n> ###### Note:\n> * This endpoint is deprecated since 10.13.0.cl. Use `getRelevantQuestions` for new integrations.\n> * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> * This endpoint requires Spotter — please contact ThoughtSpot support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n", "deprecated": true, "tags": [ "AI", "10.7.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryGetDecomposedQueryRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eureka_DecomposeQueryResponse" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eureka_DecomposeQueryResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/analysts/search": { "post": { "operationId": "searchAnalysts", "description": "\nSearches Spotter Analysts. Two modes:\n- Fetch mode: when `analyst_identifier` is provided, the response contains\n exactly that analyst and all other filters are ignored.\n- List mode: returns a paginated list of analysts visible to the caller,\n optionally filtered by a case-insensitive substring match on the\n analyst name (`query`) and by ownership (`type`). Results are ordered\n by most recently accessed.\nRequires at least one of `ADMINISTRATION`, `CAN_MANAGE_SPOTTER`, or\n`CAN_USE_SPOTTER` privileges.
Beta Version: 26.10.0.cl or later\n\nVersion: 26.10.0.cl or later\n\nSearches Spotter Analysts. Use this endpoint to page through the analysts visible to you, or to fetch a single analyst by its identifier.\n\nRequires at least one of `ADMINISTRATION`, `CAN_MANAGE_SPOTTER`, or `CAN_USE_SPOTTER` privileges. Use a bearer token for the Org whose analysts should be searched.\n\n#### Usage guidelines\n\nThe endpoint operates in one of two modes:\n\n**Fetch mode** — when `analyst_identifier` is provided, the response contains exactly that analyst (`total_size` is 1) and all other filters are ignored. The caller must have access to the analyst (owner, shared with, or admin/Spotter-management privileges).\n\n**List mode** — when `analyst_identifier` is omitted, the response is a paginated list of analysts the caller can see, ordered by most recently accessed:\n\n- `record_size` (optional): number of records per page. Default 50, between 1 and 500.\n- `record_offset` (optional): zero-based index of the first record. Default 0, maximum 10000.\n- `query` (optional): case-insensitive substring match applied to the analyst **name only**.\n- `type` (optional): ownership filter — `ALL` (default; created by or shared with me), `CREATED_BY_ME`, or `SHARED_TO_ME`.\n\nThe response contains `analysts` — the page of matching analysts — and `total_size`, the total number of matches before pagination. Each analyst includes its `id`, `name`, `description`, `instructions`, `sources` (with `id`, `type`, and display `name`), enriched `mcp_connectors` (with `id`, `name`, and `icon_url`), `icon_id`, `starter_prompts` (including the server-managed fixed prompt, marked `is_fixed`), `updated_time_in_millis` and `last_accessed_time_in_millis` (epoch milliseconds), and `created_by` / `updated_by` user references (with `id`, `name`, and `display_name`).\n\n#### Error conditions\n\n- `403` — missing privileges, or (fetch mode) no access to the requested analyst.\n- `404` — (fetch mode) no analyst with the given identifier exists in the caller's Org.\n- `422` — validation failure, such as `record_size` or `record_offset` out of range.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.10.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchAnalystsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalystSearchResponse" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalystSearchResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send": { "post": { "operationId": "sendAgentConversationMessage", "description": "\n Version: 26.5.0.cl or later\n\nVersion: 26.5.0.cl or later\n\nSends natural language messages to an existing Spotter agent conversation and returns the complete response synchronously.\n\nRequires `CAN_USE_SPOTTER` privilege and access to the metadata object associated with the conversation. The user must have access to the conversation session referenced by `conversation_identifier`. A conversation must first be created using the `createAgentConversation` API.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `conversation_identifier`: the unique session ID returned by `createAgentConversation`, used for context continuity and message tracking\n- `messages`: an array of one or more text messages to send to the agent\n\nThe API returns an array of response objects, each containing:\n\n- `type`: the kind of response — `text`, `answer`, or `error`\n- `message`: the main content of the response\n- `metadata`: additional information depending on the message type (e.g., answer metadata includes analytics and visualization details)\n\n#### Error responses\n\n| Code | Description |\n|------|----------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks permission on the referenced conversation. |\n\n> ###### Note:\n>\n> - This endpoint is Generally Available from version 26.5.0.cl.\n> - This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster.\n> - For real-time streamed responses, use `sendAgentConversationMessageStreaming` instead.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.5.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendAgentConversationMessageRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "conversation_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the conversation (used to track context)" } ], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "example_1": { "summary": "Send a message to an existing agent conversation", "value": { "messages": [ { "metadata": {}, "internal": {}, "type": "text", "text": "\n\nI'll compare sales between 2025 and 2024. First, let me get the dataset context to identify the relevant sales and date columns.", "agent_context": "" }, { "metadata": {}, "internal": {}, "type": "text", "text": "```json\n{\"search_mode\": \"semantic\", \"dataset_name\": \"(Sample) Retail - Apparel\", \"columns\": [{\"name\": \"sales\", \"type\": \"MEASURE\", \"data_type\": \"double\"}, {\"name\": \"date\", \"type\": \"ATTRIBUTE\", \"data_type\": \"date\", \"sample_values\": [\"2025\", \"2024\"]}]}\n```", "agent_context": "" }, { "metadata": {}, "internal": {}, "type": "text", "text": "\n\nPerfect! I found the sales and date columns. I can see the dataset contains sales data for both 2025 and 2024. Now I'll create a comparison query to show sales for 2025 versus 2024.", "agent_context": "" }, { "metadata": { "output": "", "worksheet_id": "cd252e5c-b552-49a8-821d-3eadaa049cca", "assumptions": "", "chart_type": "KPI", "interrupted": false, "data_awareness_enabled": true }, "internal": {}, "type": "answer", "title": "Compare total sales for 2025 vs 2024", "description": "", "session_id": "842bb67a-e08e-4861-97e8-8db9538db51d", "gen_no": 2, "sage_query": "[sales] [date] = '2025' vs [date] = '2024'", "tml_tokens": [ "[sales]", "[date] = '2025' vs [date] = '2024'" ], "formulas": [], "parameters": [], "subqueries": [], "viz_suggestion": "CAEQIBomEiQ2NjE5NzI0Yy1kMjVlLTU4MDItOWNjOC1jNDA3MWY3OWY5MzAoATIA", "ac_state": null }, { "metadata": {}, "internal": {}, "type": "text", "text": "\n\nThe visualization shows the side-by-side comparison of total sales (in USD) between the two years, allowing you to see the year-over-year performance. You can see the sales figures for both 2024 and 2025, making it easy to identify growth or decline trends in your retail apparel business.", "agent_context": "" } ] } } } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/conversation/{conversation_identifier}/send/stream": { "post": { "operationId": "sendAgentConversationMessageStreaming", "description": "\n Version: 26.5.0.cl or later\n\nVersion: 26.5.0.cl or later\n\nSends one or more natural language messages to an existing Spotter agent conversation and returns the response as a real-time Server-Sent Events stream.\n\nRequires `CAN_USE_SPOTTER` privilege and access to the metadata object associated with the conversation. The user must have access to the conversation session referenced by `conversation_identifier`. A conversation must first be created using the `createAgentConversation` API.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `conversation_identifier`: the unique session ID returned by `createAgentConversation`, used for context continuity and message tracking\n- `messages`: an array of one or more text messages to send to the agent\n\nIf the request is valid, the API returns a Server-Sent Events (SSE) stream. Each line has the form `data: [{\"type\": \"...\", ...}]` — a JSON array of event objects. Event types include:\n\n- `ack`: confirms receipt of the request (`node_id`)\n- `conv_title`: conversation title (`title`, `conv_id`)\n- `notification`: status updates on operations (`group_id`, `metadata`, `code` — e.g. `TOOL_CALL_NOTIFICATION`, `nls_start`, `FINAL_RESPONSE_NOTIFICATION`)\n- `text-chunk`: incremental content chunks (`id`, `group_id`, `metadata` with `format` and `type` such as `thinking` or `text`, `content`)\n- `text`: full text block with same structure as `text-chunk`\n- `answer`: structured answer with metadata (`id`, `group_id`, `metadata` with `sage_query`, `session_id`, `title`, etc., `title`)\n- `error`: if a failure occurs\n\n#### Error responses\n\n| Code | Description |\n| ---- | -------------------------------------------------------------------------------------------------------------------------------- |\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks permission on the referenced conversation. |\n\n> ###### Note:\n>\n> - This endpoint is Generally Available from version 26.5.0.cl.\n> - This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster.\n> - The streaming protocol uses Server-Sent Events (SSE).\n> - For the complete response in a single payload, use `sendAgentConversationMessage` instead.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.5.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendAgentConversationMessageStreamingRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "conversation_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the conversation (used to track context)" } ], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendAgentMessageResponse" }, "examples": { "example_1": { "summary": "SSE stream — each line is data: [{\"type\": \"...\", ...}]. Events arrive over time; this example shows a minimal sequence.", "value": [ { "type": "ack", "node_id": "aGxzcFVrtom8" }, { "type": "conv_title", "title": "Sales 2025 vs 2024", "conv_id": "-XIi04l5rrof" }, { "type": "notification", "group_id": "cDEsAQbSnd3J", "metadata": { "type": "thinking", "tool_title": "Analyzing Sales Performance: 2025 vs 2024" }, "code": "TOOL_CALL_NOTIFICATION" }, { "id": "mNAdvy-NK2l6", "type": "text-chunk", "group_id": "cDEsAQbSnd3J", "metadata": { "format": "markdown", "type": "thinking" }, "content": "\n\nI need to compare sales performance between 2025 and 2024." }, { "id": "hxWMDP-pgR3B", "type": "answer", "group_id": "m1MTvttEUa7o", "metadata": { "sage_query": "[sales] [date] = '2025' vs [date] = '2024'", "session_id": "431adcf9-1328-4d8c-81a1-0faa7fa37ba6", "title": "Compare sales for 2025 vs 2024" }, "title": "Compare sales for 2025 vs 2024" } ] } } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendAgentMessageResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-streaming": true } }, "/api/rest/2.0/ai/agent/{conversation_identifier}/converse": { "post": { "operationId": "sendAgentMessage", "description": "\nBeta Version: 26.2.0.cl or later\n\n**Deprecated** — Use `sendAgentConversationMessage` instead.\n\nSend natural language messages to an existing Spotter agent conversation and returns the complete response synchronously.\n\nRequires `CAN_USE_SPOTTER` privilege and access to the metadata object associated with the conversation. The user must have access to the conversation session referenced by `conversation_identifier`.\nA conversation must first be created using the `createAgentConversation` API.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `conversation_identifier`: the unique session ID returned by `createAgentConversation`, used for context continuity and message tracking\n- `messages`: an array of one or more text messages to send to the agent\n\nThe API returns an array of response objects, each containing:\n\n- `type`: the kind of response — `text`, `answer`, or `error`\n- `message`: the main content of the response\n- `metadata`: additional information depending on the message type (e.g., answer metadata includes analytics and visualization details)\n\n#### Error responses\n\n| Code | Description |\n|------|----------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks permission on the referenced conversation. |\n\n> ###### Note:\n>\n> - This endpoint is deprecated. Use `sendAgentConversationMessage` for new integrations.\n> - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> - This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n", "deprecated": true, "tags": [ "AI", "26.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendAgentMessageRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "conversation_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the conversation (used to track context)" } ], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/converse/sse": { "post": { "operationId": "sendAgentMessageStreaming", "description": "\nBeta Version: 26.2.0.cl or later\n\n**Deprecated** — Use `sendAgentConversationMessageStreaming` instead.\n\nSends one or more natural language messages to an existing Spotter agent conversation and returns the response as a real-time Server-Sent Events stream.\n\nRequires `CAN_USE_SPOTTER` privilege and access to the metadata object associated with the conversation. The user must have access to the conversation session referenced by `conversation_identifier`. A conversation must first be created using the `createAgentConversation` API.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `conversation_identifier`: the unique session ID returned by `createAgentConversation`, used for context continuity and message tracking\n- `messages`: an array of one or more text messages to send to the agent\n\nIf the request is valid, the API returns a Server-Sent Events (SSE) stream. Each line has the form `data: [{\"type\": \"...\", ...}]` — a JSON array of event objects. Event types include:\n\n- `ack`: confirms receipt of the request (`node_id`)\n- `conv_title`: conversation title (`title`, `conv_id`)\n- `notification`: status updates on operations (`group_id`, `metadata`, `code` — e.g. `TOOL_CALL_NOTIFICATION`, `nls_start`, `FINAL_RESPONSE_NOTIFICATION`)\n- `text-chunk`: incremental content chunks (`id`, `group_id`, `metadata` with `format` and `type` such as `thinking` or `text`, `content`)\n- `text`: full text block with same structure as `text-chunk`\n- `answer`: structured answer with metadata (`id`, `group_id`, `metadata` with `sage_query`, `session_id`, `title`, etc., `title`)\n- `error`: if a failure occurs\n\n#### Error responses\n\n| Code | Description |\n|------|----------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks permission on the referenced conversation. |\n\n> ###### Note:\n>\n> - This endpoint is deprecated. Use `sendAgentConversationMessageStreaming` for new integrations.\n> - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> - This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster.\n> - The streaming protocol uses Server-Sent Events (SSE).\n\n\n\n\n#### Endpoint URL\n", "deprecated": true, "tags": [ "AI", "26.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendAgentMessageStreamingRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendAgentMessageResponse" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendAgentMessageResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "x-streaming": true } }, "/api/rest/2.0/ai/conversation/{conversation_identifier}/converse": { "post": { "operationId": "sendMessage", "description": "\nBeta Version: 10.4.0.cl or later\n\nSends a follow-up message to an existing conversation within the context of a data model.\n\nRequires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request. A conversation must first be created using the `createConversation` API.\n\n#### Usage guidelines\n\nThe request must include:\n- `conversation_identifier`: the unique session ID returned by `createConversation`\n- `metadata_identifier`: the unique ID of the data source used for the conversation\n- `message`: a natural language string with the follow-up question\n\nIf the request is successful, the API returns an array of response messages, each containing:\n- `session_identifier`: the unique ID of the generated response\n- `generation_number`: the generation number of the response\n- `message_type`: the type of the response (e.g., `TSAnswer`)\n- `visualization_type`: the generated visualization type (`Chart`, `Table`, or `Undefined`)\n- `tokens` / `display_tokens`: the search tokens and user-friendly display tokens for the response\n\n#### Error responses\n\n| Code | Description |\n|------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the specified metadata object. |\n\n> ###### Note:\n> * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "10.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "conversation_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the conversation." } ], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseMessage" } } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseMessage" } } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/instructions/set": { "put": { "operationId": "setAgentInstructions", "description": "\nBeta Version: 26.6.0.cl or later\n\nCreates or updates the admin instructions for the AI agent (Spotter). Admin instructions are tenant- and org-scoped text that guide agent behavior across all conversations. If instructions already exist for the org, they are replaced (upsert semantics).\n\nRequires admin privileges. Only users with org admin access can set agent instructions.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `instructions`: the instructions text to apply to the agent (maximum 5000 characters)\n\nInstructions are validated against system guardrails before being saved. If the instructions contain content that conflicts with guardrails, the request is rejected with a `409` error and the existing instructions remain unchanged.\n\nIf the request is successful, the response includes the saved `AgentInstructions` record:\n\n- `id`: unique identifier of the record\n- `instructions`: the saved instructions text\n- `created_at`: ISO timestamp when the instructions were first created\n- `updated_at`: ISO timestamp of this update\n- `last_updated_by`: user ID of the admin who performed this update\n\n#### Error responses\n\n| Code | Description |\n|------|-------------|\n| 400 | Bad request — the request body is missing required fields or the `instructions` field exceeds the maximum allowed length of 5000 characters. |\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have org admin privileges required to set agent instructions. |\n| 409 | Conflict — the provided instructions conflict with system guardrails. Review and revise the instructions text before retrying. |\n| 500 | Internal server error. |\n\n> ###### Note:\n>\n> - This operation uses upsert semantics: it creates the instructions record if none exists, or replaces the existing one.\n> - Instructions take effect immediately for new conversations created after the update.\n> - Use `getAgentInstructions` to retrieve the current instructions before making changes.\n> - Available from version 26.6.0.cl and later.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.6.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAgentInstructionsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentInstructions" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentInstructions" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/instructions/set": { "post": { "operationId": "setNLInstructions", "description": "\nBeta Version: 10.15.0.cl or later\n\nThis API allows users to set natural language (NL) instructions for a specific data-model to improve AI-generated answers and query processing. These instructions help guide the AI system to better understand the data context and provide more accurate responses.\n\nRequires `CAN_USE_SPOTTER` privilege, either edit access or `SPOTTER_COACHING_PRIVILEGE` on the data model, and a bearer token corresponding to the org where the data model exists.\n\n#### Usage guidelines\n\nTo set NL instructions for a data-model, the request must include:\n\n- `data_source_identifier`: The unique ID of the data-model for which to set NL instructions\n- `nl_instructions_info`: An array of instruction objects, each containing:\n - `instructions`: Array of text instructions for the LLM\n - `scope`: The scope of the instruction (`GLOBAL`). Currently only `GLOBAL` is supported. It can be extended to data-model-user scope in future.\n\n#### Instructions scope\n\n- **GLOBAL**: instructions that apply to all users querying this data model\n\nIf the request is successful, the API returns:\n\n- `success`: a boolean indicating whether the operation completed successfully\n\n#### Error responses\n\n| Code | Description |\n|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege, lacks edit access or `SPOTTER_COACHING_PRIVILEGE` on the data model, or the bearer token does not correspond to the org where the data model exists. |\n\n> ###### Note:\n>\n> - To use this API, the user needs either edit access or `SPOTTER_COACHING_PRIVILEGE` on the data model, and must use the bearer token corresponding to the org where the data model exists.\n> - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> - Available from version 10.15.0.cl and later.\n> - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\n> - Instructions help improve the accuracy and relevance of AI-generated responses for the specified data-model.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "10.15.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetNLInstructionsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eureka_SetNLInstructionsResponse" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/eureka_SetNLInstructionsResponse" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/analysts/{analyst_identifier}/share": { "post": { "operationId": "shareAnalyst", "description": "\nUpdates share permissions on a Spotter Analyst, one entry per principal\n(user or group). `READ_ONLY` and `MODIFY` grant or change the principal's\naccess; `NO_ACCESS` revokes it. Granting access also shares the analyst's\ndata sources with the principal so the analyst keeps working for them.\nA successful share returns an empty `204 No Content` response.\nRequires ownership of the analyst, or `ADMINISTRATION` or\n`CAN_MANAGE_SPOTTER` privileges.
Beta Version: 26.10.0.cl or later\n\nVersion: 26.10.0.cl or later\n\nUpdates share permissions on a Spotter Analyst for one or more principals (users or groups).\n\nRequires ownership of the analyst, or `ADMINISTRATION` or `CAN_MANAGE_SPOTTER` privileges. Use a bearer token for the Org in which the analyst exists.\n\n#### Usage guidelines\n\nThe analyst is identified by the `analyst_identifier` path parameter. The request body contains a `permissions` array with one entry per principal:\n\n- `principal.identifier` (required): unique identifier of the user or group.\n- `principal.type` (required): `USER` or `USER_GROUP`.\n- `share_mode` (required): `READ_ONLY` or `MODIFY` grants (or changes) the principal's access; `NO_ACCESS` revokes it.\n\nA principal may appear at most once per request. When access is granted, the analyst's data sources are automatically shared with the principal as well, so the analyst keeps working for them.\n\nA successful request returns an empty `204 No Content` response.\n\n#### Error conditions\n\n- `400` — malformed analyst identifier.\n- `403` — the caller is not the analyst's author and lacks admin / Spotter-management privileges.\n- `404` — no analyst with the given identifier exists in the caller's Org.\n- `422` — validation failure, such as an empty `permissions` array, a duplicate principal, or a missing field.\n- `429` — rate limit exceeded.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.10.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareAnalystRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "analyst_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the analyst to share." } ], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/conversations/{conversation_identifier}/share": { "post": { "operationId": "shareConversation", "description": "\nGrants or revokes access to a shared conversation for one or more principals\n(users or groups). When principals are added, a read-only shared view of the\nconversation is created from its current state. Use `refresh_shared_content`\nto regenerate the shared view with the latest conversation content.\nRequires `CAN_USE_SPOTTER` privilege and ownership of the specified conversation.
Version: 26.9.0.cl or later\n\nGrants or revokes access to a shared conversation for one or more principals (users or groups). When principals are added, a read-only shared view of the conversation is created from its current state. The shared view is a point-in-time copy — use `refresh_shared_content` to regenerate it with the latest conversation content.\n\nRequires ownership of the specified conversation. Only the user who created the conversation can manage its share access.\n\n#### Usage guidelines\n\nThe conversation to share is identified by the `{conversation_identifier}` URL path parameter. At least one of the following must be true: `grant` is non-empty, `revoke` is non-empty, or `refresh_shared_content` is `true`. A principal cannot appear in both lists in the same request.\n\n| Field | Type | Default | Description |\n| --- | --- | --- | --- |\n| `refresh_shared_content` | `Boolean` | `false` | When `true`, always regenerates the shared view from the latest conversation state, even if a shared view already exists. When `false`, reuses the existing shared view. |\n| `grant` | `PrincipalRefInput[]` | `[]` | Principals to grant read-only access. |\n| `revoke` | `PrincipalRefInput[]` | `[]` | Principals to revoke access from. |\n| `notify_on_share` | `Boolean` | `true` | *(available from 26.10.0.cl)* When `true`, newly granted principals are notified of the share. When `false`, access is granted without sending a notification. Has no effect on principals passed in `revoke`, and does not re-notify a principal who already had access. |\n\n#### PrincipalRefInput fields\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `principal_identifier` | `String` | Unique identifier of the user or group. |\n| `principal_type` | `Principals` | `USER` for individual users, `USER_GROUP` for groups. |\n\n#### Example request — granting access\n\n```bash\nPOST /api/rest/2.0/ai/agent/conversations/{conversation_identifier}/share\n```\n\n```json\n{\n \"refresh_shared_content\": false,\n \"grant\": [\n { \"principal_identifier\": \"user-001\", \"principal_type\": \"USER\" },\n { \"principal_identifier\": \"group-001\", \"principal_type\": \"USER_GROUP\" }\n ],\n \"revoke\": [],\n \"notify_on_share\": true\n}\n```\n\n#### Example request — revoking access\n\n```json\n{\n \"refresh_shared_content\": false,\n \"grant\": [],\n \"revoke\": [\n { \"principal_identifier\": \"user-001\", \"principal_type\": \"USER\" }\n ]\n}\n```\n\nSet `refresh_shared_content: true` with empty `grant` and `revoke` to regenerate the shared snapshot for existing recipients without changing access. Combine with non-empty `grant` or `revoke` to update access and refresh the snapshot in a single call.\n\n#### Error responses\n\n| Code | Description |\n| --- | --- |\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the caller does not own the specified conversation, or does not have `CAN_USE_SPOTTER` privilege. |\n| 404 | Not Found — no conversation exists with the given identifier for the authenticated user. |\n| 422 | Unprocessable — `refresh_shared_content` is `false` and both `grant` and `revoke` are empty, or a principal appears in both lists. |\n\n> ###### Note:\n>\n> - The shared view is a read-only snapshot of the conversation at the time of sharing. Recipients cannot send messages or modify the conversation.\n> - Use `getShareInfo` to check whether the shared view is outdated relative to the current conversation state.\n> - `notify_on_share: false` only suppresses the share notification; access is still granted.\n> - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\nVersion: 26.9.0.cl or later\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.9.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareConversationRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "conversation_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the conversation to share." } ], "responses": { "204": { "description": "Successfully updated the share access for the conversation." }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/answer/create": { "post": { "operationId": "singleAnswer", "description": "\nBeta Version: 10.4.0.cl or later\n\nProcesses a natural language query against a specified data model and returns a single AI-generated answer without requiring a conversation session.\n\nRequires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request.\n\n#### Usage guidelines\n\nThe request must include:\n- `query`: a natural language question (e.g., \"What were total sales last quarter?\")\n- `metadata_identifier`: the unique ID of the data source to query against\n\nIf the request is successful, the API returns a response message containing:\n- `session_identifier`: the unique ID of the generated response\n- `generation_number`: the generation number of the response\n- `message_type`: the type of the response (e.g., `TSAnswer`)\n- `visualization_type`: the generated visualization type (`Chart`, `Table`, or `Undefined`)\n- `tokens` / `display_tokens`: the search tokens and user-friendly display tokens for the response\n\n#### Error responses\n\n| Code | Description |\n|------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the specified metadata object. |\n\n> ###### Note:\n> * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available.\n> * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "10.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleAnswerRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseMessage" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseMessage" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/conversation/{conversation_identifier}/stop-response": { "post": { "operationId": "stopConversation", "description": "\nStops an in-progress agent conversation response.
Version: 26.6.0.cl or later\n\nVersion: 26.6.0.cl or later\n\nStops an in-progress agent response for the specified conversation. Use this endpoint to cancel a response that is actively being generated — for example, when the user navigates away, reformulates their question, or no longer needs the current result.\n\nRequires `CAN_USE_SPOTTER` privilege and access to the specified conversation.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `conversation_identifier` *(path parameter)*: the unique ID of the conversation whose active response should be stopped, as returned by `createAgentConversation`\n\nA successful request returns an empty `204 No Content` response. If there is no active response in progress at the time of the call, the request is still treated as successful.\n\nAfter stopping a response, the conversation session remains active. You can continue sending messages using `sendAgentConversationMessage` or `sendAgentConversationMessageStreaming`.\n\n#### Example request\n\n```bash\nPOST /api/rest/2.0/ai/agent/conversation/{conversation_identifier}/stop-response\n```\n\n#### Typical usage scenario\n\nThis endpoint is useful when integrating Spotter into a chat UI where users can cancel a long-running query. For example:\n\n1. User sends a message via `sendAgentConversationMessageStreaming`.\n2. User clicks a \"Stop generating\" button while the response is streaming.\n3. Your client calls `stopConversation` with the active `conversation_identifier`.\n4. The stream is terminated and the user can ask a new question.\n\n#### Error responses\n\n| Code | Description |\n|------|-------------|\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks access to the specified conversation. |\n\n> ###### Note:\n>\n> - Calling this endpoint when no response is in progress does not return an error.\n> - The conversation context is preserved after stopping — previous messages and answers remain accessible.\n> - Available from version 26.6.0.cl and later.\n> - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\n> - This feature is available only for **Spotter 3** (`SPOTTER3`) version.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.6.0.cl" ], "parameters": [ { "in": "path", "name": "conversation_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the conversation to stop." } ], "responses": { "204": { "description": "Successfully stopped the in-progress agent conversation response for the given." }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/analysts/{analyst_identifier}/update": { "post": { "operationId": "updateAnalyst", "description": "\nUpdates a Spotter Analyst. The request body is identical to\n`createAnalyst` and the update is a full replace: the analyst is\nrewritten from the request, and optional fields omitted from the request\nare reset (no instructions, no MCP connectors, no starter prompts).\nRequires ownership of the analyst, or `ADMINISTRATION` or\n`CAN_MANAGE_SPOTTER` privileges. Users the analyst is shared with cannot\nedit it.
Beta Version: 26.10.0.cl or later\n\nVersion: 26.10.0.cl or later\n\nUpdates a Spotter Analyst. The request body is identical to the create analyst API, and the update is a full replace: the analyst is rewritten from the request, and optional fields omitted from the request are reset.\n\nRequires ownership of the analyst, or `ADMINISTRATION` or `CAN_MANAGE_SPOTTER` privileges. Users the analyst is shared with can use it but cannot edit it. Use a bearer token for the Org in which the analyst exists.\n\n#### Usage guidelines\n\nThe request body is flat — all fields are top-level:\n\n- `name` (required): display name of the analyst.\n- `description` (required): up to 200 characters.\n- `instructions` (optional): natural-language instructions that guide the agent's behavior. Instructions that conflict with system guardrails are rejected with `409`. Omitting this field clears any existing instructions.\n- `sources` (required): at least one data source the analyst can query, each with an `identifier`, an optional `name`, and a `type` (`MODEL`, `ANSWER`, `LIVEBOARD`, or `CONVERSATION`). Replaces the existing list in full. When new sources are added, they are automatically shared with users the analyst was previously shared with, so those users keep a working analyst.\n- `mcp_connector_identifiers` (optional): identifiers of MCP connectors. Replaces the existing list in full; omit or pass an empty array to clear.\n- `starter_prompts` (optional): up to 4 plain-text prompts, each between 10 and 250 characters; display order follows list position. Replaces the existing list in full; omit or pass an empty array to clear.\n\nIf the request is successful, the response contains the updated analyst, including the refreshed `updated_time_in_millis` timestamp (epoch milliseconds) and `updated_by` user. In responses, sources are returned with `id` and `type`, connector identifiers as `mcp_connectors`, and starter prompts as structured objects (`label`, `text`, `order`, `is_ai_generated`).\n\n#### Error conditions\n\n- `400` — malformed analyst identifier.\n- `403` — the caller is not the analyst's author and lacks admin / Spotter-management privileges.\n- `404` — no analyst with the given identifier exists in the caller's Org.\n- `409` — `instructions` conflict with system guardrails.\n- `422` — validation failure, such as a missing required field (`name`, `description`, or `sources`), an empty `sources` list, too many starter prompts, or field-length violations.\n- `429` — rate limit exceeded.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.10.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAnalystRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "analyst_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the analyst to update." } ], "responses": { "200": { "description": "Common successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Analyst" } } } }, "201": { "description": "Common error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Analyst" } } } }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/ai/agent/conversations/{conversation_identifier}/update": { "post": { "operationId": "updateConversation", "description": "\nUpdates attributes of an existing agent conversation. Supports updating the\ndisplay title and the pinned state; additional conversation attributes may be\nsupported in future versions. At least one updatable attribute must be\nprovided in the request body. Each attribute is applied independently, so\nomitted attributes are left unchanged.
Version: 26.7.0.cl or later\n\nUpdates attributes of an existing saved agent conversation. Supports updating the conversation's display `title` and its `is_pinned` state; additional updatable attributes may be supported in future versions. At least one updatable attribute must be supplied in the request body.\n\nUse this endpoint to rename a conversation, or to pin a conversation so that it is surfaced first in the conversation list for quick access.\n\nRequires `CAN_USE_SPOTTER` privilege and ownership of the conversation being updated.\n\n#### Usage guidelines\n\nThe request must include:\n\n- `conversation_identifier` *(path parameter)*: the unique ID of the conversation to update, as returned by `createAgentConversation` or `getConversationList`\n- At least one updatable attribute in the request body:\n - `title` *(optional)*: the new display name for the conversation. An empty or whitespace-only value is replaced with a default title rather than rejected.\n - `is_pinned` *(optional)*: `true` to pin the conversation, `false` to unpin it. Available from version 26.10.0.cl.\n\nEach attribute is applied independently: omitted attributes are left unchanged, so you can update the title and the pinned state in a single request or in separate requests. Updating `is_pinned` is idempotent — pinning an already-pinned conversation, or unpinning an already-unpinned one, succeeds with no side effects.\n\nA successful request returns an empty `204 No Content` response. Updated attributes are reflected immediately in subsequent calls to `getConversationList`.\n\n#### Example request\n\nRename a conversation:\n\n```bash\nPOST /api/rest/2.0/ai/agent/conversations/{conversation_identifier}/update\nContent-Type: application/json\n\n{\n \"title\": \"Revenue Breakdown by Product Line\"\n}\n```\n\nPin a conversation:\n\n```bash\nPOST /api/rest/2.0/ai/agent/conversations/{conversation_identifier}/update\nContent-Type: application/json\n\n{\n \"is_pinned\": true\n}\n```\n\nUpdate both attributes in a single request:\n\n```bash\nPOST /api/rest/2.0/ai/agent/conversations/{conversation_identifier}/update\nContent-Type: application/json\n\n{\n \"title\": \"Revenue Breakdown by Product Line\",\n \"is_pinned\": true\n}\n```\n\n#### Error responses\n\n| Code | Description |\n|------|-------------|\n| 400 | Bad Request — the request body supplies neither `title` nor `is_pinned`, or `is_pinned` is not a boolean. |\n| 401 | Unauthorized — authentication token is missing, expired, or invalid. |\n| 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or does not own the specified conversation. |\n| 404 | Not Found — no conversation exists with the given `conversation_identifier` for the authenticated user. |\n| 422 | Unprocessable Entity — the request body is malformed or contains an invalid field value. |\n\n> ###### Note:\n>\n> - Only conversations created with `enable_save_chat: true` can be updated. Unsaved conversations are not persisted and do not have a retrievable identifier.\n> - There is no limit on the number of conversations a user can pin.\n> - Available from version 26.7.0.cl and later. The `is_pinned` attribute is available from version 26.10.0.cl and later.\n> - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "AI", "26.7.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConversationRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "conversation_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the conversation to update." } ], "responses": { "204": { "description": "Successfully updated the agent conversation." }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/auth/configure": { "post": { "operationId": "configureAuthSettings", "description": "\n Version: 26.6.0.cl or later\n\nVersion: 26.6.0.cl or later\n\nEnables or disables authentication at cluster or org level for the specified auth type. Currently supports `TRUSTED_AUTH`.\n\n#### Required privileges\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `CONTROL_TRUSTED_AUTH` (**Can Enable or Disable Trusted Authentication**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CONTROL_TRUSTED_AUTH` privilege is required.\n\n#### Usage guidelines\n\nUse `cluster_preferences` to enable or disable authentication at the cluster level. Cluster-level settings can only be configured from the Primary Org.\n- `ENABLED` — Generates a new access token if one does not exist. An existing token is preserved.\n- `DISABLED` — Revokes the existing cluster-level access token.\n\nUse `org_preferences` to enable or disable authentication for one or more Orgs. Each entry must include an `org_identifier` (unique ID or name) and an `auth_status`. Org-level configuration requires the per-Org authentication feature to be enabled on your instance.\n- `ENABLED` — Generates a new org-level access token if one does not exist.\n- `DISABLED` — Revokes the existing org-level access token for that Org.\n\nBoth `cluster_preferences` and `org_preferences` are optional. Omitting a field leaves the corresponding settings unchanged. If both are omitted, the API returns `204 No Content` without making any changes.\n\n**Note**: Cluster-level and org-level settings are independent of each other. Enabling or disabling one does not affect the other.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Authentication", "26.6.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigureAuthSettingsRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Trusted authentication settings configured successfully." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "At least one of cluster_preferences or org_preferences must be provided." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to configure authentication settings." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "ADMINISTRATION or CONTROL_TRUSTED_AUTH privilege required to configure authentication settings." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while configuring authentication settings." } } } } } } } } } } }, "/api/rest/2.0/auth/session/user": { "get": { "operationId": "getCurrentUserInfo", "description": "\n Version: 9.0.0.cl or later\n\nRetrieves details of the current user session for the token provided in the request header.\n\nAny ThoughtSpot user can access this endpoint and send an API request. The data returned in the API response varies according to user's privilege and object access permissions.\n\n**NOTE**: In ThoughtSpot, users with cluster administration privileges can access all Orgs by default. However, unless the administrator is explicitly added to an Org, the Orgs list in the session information returned by the API will include only the Primary Org. To include other Orgs in the API response, you must explicitly add the administrator to each Org in the Admin settings page in the UI or via user REST API.\n\n\n\n#### Endpoint URL\n", "tags": [ "Authentication", "9.0.0.cl" ], "parameters": [], "responses": { "200": { "description": "Fetch current session user detail successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { "example_1": { "description": "Current user info for an admin user in the primary org", "value": { "id": "59481331-ee53-42be-a548-bd87be6ddd4a", "name": "tsadmin", "display_name": "TS Admin", "visibility": "SHARABLE", "author_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "can_change_password": true, "complete_detail": true, "creation_time_in_millis": 1699900000000, "current_org": { "id": 0, "name": "Primary" }, "deleted": false, "deprecated": false, "account_type": "LOCAL_USER", "account_status": "ACTIVE", "owner_id": "3c4d5e6f-0001-4a2b-8c3d-4e5f6a7b8c9d", "modifier_id": "3c4d5e6f-0002-4b3c-9d4e-5f6a7b8c9d0e", "tenant_id": "3c4d5e6f-0003-4c4d-8e5f-6a7b8c9d0e1f", "parent_type": "USER", "orgs": [ { "id": 0, "name": "Primary" } ], "privileges": [ "ADMINISTRATION", "AUTHORING", "DATADOWNLOADING" ], "user_groups": [ { "id": "3c4d5e6f-0004-4d5e-9f6a-7b8c9d0e1f2a", "name": "Administrators" } ], "user_inherited_groups": [ { "id": "3c4d5e6f-0005-4e6f-8a7b-8c9d0e1f2a3b", "name": "All" } ], "home_liveboard": { "id": "3c4d5e6f-0006-4f7a-9b8c-9d0e1f2a3b4c", "name": "Cluster Health" }, "favorite_metadata": [ { "id": "3c4d5e6f-0007-4a8b-8c9d-0e1f2a3b4c5d", "name": "Quarterly Revenue", "type": "LIVEBOARD" } ], "tags": [ { "id": "3c4d5e6f-0008-4b9c-9d0e-1f2a3b4c5d6e", "name": "certified" } ], "group_mask": 6, "preferred_locale": "en-US", "use_browser_language": false, "notify_on_share": true, "welcome_email_sent": true, "onboarding_experience_completed": true, "show_onboarding_experience": false, "is_first_login": false, "super_user": true, "system_user": false, "external": false, "hidden": false, "modification_time_in_millis": 1699900060000, "first_login_time_in_millis": 1699900100000, "expiration_time_in_millis": 1731522000000, "extended_preferences": { "": "" }, "user_parameters": { "0": { "runtime_filters": [ { "column_name": "Region", "operator": "EQ", "values": [ "East" ] } ], "parameters": [ { "name": "Discount Rate", "values": [ "0.1" ] } ] } }, "access_control_properties": { "0": { "ALL": { "filter_rules": [ { "column_name": "Region", "operator": "EQ", "values": [ "East" ] } ] } } }, "variable_values": { "0": { "ALL": { "variable_values": [ { "name": "color", "values": [ "red" ] } ] } } }, "incomplete_details": [], "org_privileges": { "0": [ "ADMINISTRATION", "AUTHORING", "DATADOWNLOADING" ] }, "extended_properties": { "displayNameLastUpdatedBy": "ADMIN" }, "email": "tsadmin@example.com" } }, "example_2": { "description": "Current user info for a SAML user switched to a non-primary org", "value": { "id": "7e4c9f2a-8b5d-4a1e-9c3b-6d8e2f5a7b4c", "name": "sales_analyst", "display_name": "Sales Analyst", "visibility": "SHARABLE", "author_id": "7e4c9f2a-8b5d-4a1e-9c3b-6d8e2f5a7b4c", "can_change_password": false, "complete_detail": true, "creation_time_in_millis": 1699900000000, "current_org": { "id": 583464508, "name": "sales_org" }, "deleted": false, "deprecated": false, "account_type": "SAML_USER", "account_status": "ACTIVE", "email": "sales_analyst@example.com" } }, "example_3": { "description": "Current user info for a SAML user switched to a non-primary Org, with a home Liveboard and a preferred locale", "value": { "id": "7e4c9f2a-8b5d-4a1e-9c3b-6d8e2f5a7b4c", "name": "sales_analyst", "display_name": "Sales Analyst", "visibility": "SHARABLE", "author_id": "7e4c9f2a-8b5d-4a1e-9c3b-6d8e2f5a7b4c", "can_change_password": false, "complete_detail": true, "creation_time_in_millis": 1699900000000, "current_org": { "id": 583464508, "name": "sales_org" }, "deleted": false, "deprecated": false, "account_type": "SAML_USER", "account_status": "ACTIVE", "email": "sales_analyst@example.com", "external": false, "favorite_metadata": [], "first_login_time_in_millis": 1699900005000, "hidden": false, "home_liveboard": { "id": "c8e4d2a1-6b3f-4e7a-9d5c-2f1a8b7e6d4c", "name": "Regional Sales" }, "is_first_login": false, "modification_time_in_millis": 1724277430000, "modifier_id": "7e4c9f2a-8b5d-4a1e-9c3b-6d8e2f5a7b4c", "notify_on_share": true, "onboarding_experience_completed": true, "orgs": [ { "id": 0, "name": "Primary" }, { "id": 583464508, "name": "sales_org" } ], "owner_id": "7e4c9f2a-8b5d-4a1e-9c3b-6d8e2f5a7b4c", "parent_type": "USER", "privileges": [ "AUTHORING", "DATADOWNLOADING" ], "show_onboarding_experience": false, "super_user": false, "system_user": false, "tags": [], "user_groups": [ { "id": "4f8a2c6e-1d3b-4a5f-8e7c-9b0d2a4c6e8f", "name": "Sales Analysts" } ], "user_inherited_groups": [ { "id": "4f8a2c6e-1d3b-4a5f-8e7c-9b0d2a4c6e8f", "name": "Sales Analysts" }, { "id": "b9e7d5c3-2f1a-4e8d-9c6b-0a3d7f2e1b5c", "name": "All Analysts" } ], "welcome_email_sent": false, "org_privileges": { "583464508": [ "AUTHORING", "DATADOWNLOADING" ] }, "preferred_locale": "en-GB", "use_browser_language": false, "extended_properties": { "displayNameLastUpdatedBy": "AUTO" } } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to retrieve the current user information." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while retrieving current user information." } } } } } } } } } } }, "/api/rest/2.0/auth/session/token": { "get": { "operationId": "getCurrentUserToken", "description": "\n Version: 9.4.0.cl or later\n\nGenerates a new bearer token from an existing authenticated session.\n\n#### Required privileges\nAny ThoughtSpot user with a valid bearer token can access this endpoint and send an API request. Requires no additional privileges.\n\n#### Usage guidelines\nThis endpoint doesn't return the caller's existing session token. Instead, it issues a new token based on the current authenticated session and returns the new token string, its creation and expiration timestamps, and the associated user details in response. The token generated from this API request is valid for 24 hours.\n\nUse this endpoint when your application needs a new token without requiring the user to re-authenticate. If you need a token with a specific expiration or a different security scope, use `POST /api/rest/2.0/auth/token/full`, `POST /api/rest/2.0/auth/token/custom`, or `POST /api/rest/2.0/auth/token/object` instead.\n\n\n\n#### Endpoint URL\n", "tags": [ "Authentication", "9.4.0.cl" ], "parameters": [], "responses": { "200": { "description": "Fetching token for current user successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTokenResponse" }, "examples": { "example_1": { "description": "Standard session token valid for 1 hour", "value": { "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example_token_payload.signature", "creation_time_in_millis": 1724277430000, "expiration_time_in_millis": 1724281030000, "valid_for_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "valid_for_username": "tsadmin" } }, "example_2": { "description": "Short-lived session token valid for 5 minutes", "value": { "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example_short_token_payload.signature", "creation_time_in_millis": 1724277430000, "expiration_time_in_millis": 1724277730000, "valid_for_user_id": "7e4c9f2a-8b5d-4a1e-9c3b-6d8e2f5a7b4c", "valid_for_username": "sales_analyst" } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to retrieve the current session token." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "impersonation_session": { "summary": "Token requested during an Act As You session", "description": "An administrator who is impersonating another user cannot fetch a token for that user.", "value": { "error": { "message": { "code": 10125, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Authentication tokens cannot be fetched during an 'Act As You' session." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while retrieving the current user session token." } } } } } } } } } } }, "/api/rest/2.0/auth/token/custom": { "post": { "operationId": "getCustomAccessToken", "description": "\n Version: 10.4.0.cl or later\n\nCreates an authentication token that provides values for the formula variables in the Row Level Security (RLS) rules for a given user. Recommended for use cases that require Attribute-based access control (ABAC) via RLS.\n\n#### Required privileges\n\nTo add a new user and assign privileges during auto-creation, the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege is required. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CONTROL_TRUSTED_AUTH` (**Can Enable or Disable Trusted Authentication**) privilege and edit access to the data source are required.\n\nTo configure formula variables for all Orgs on your instance or the Primary Org, cluster administration privileges are required. Org administrators can configure formula variables for their respective Orgs. If Role-Based Access Control (RBAC) is enabled, users with the `CAN_MANAGE_VARIABLES` (**Can manage variables**) role privilege can also create and manage variables for their Org context.\n\n#### Usage guidelines\n\nYou can generate a token by providing a `username` and `password`, or by using a `secret_key`. To generate a `secret_key`, the administrator must enable [Trusted authentication](https://developers.thoughtspot.com/docs/trusted-auth-secret-key) in the **Develop** > **Customizations** > **Security Settings** page.\n\n**Note**:\n* When both `password` and `secret_key` are included in the API request, `secret_key` takes precedence.\n* If [Multi-Factor Authentication (MFA)](https://docs.thoughtspot.com/cloud/latest/authentication-local-mfa) is enabled on your instance, the API login request with `username` and `password` returns an error. You can switch to token-based authentication with `secret_key` or contact ThoughtSpot Support for assistance.\n\nThe token obtained from ThoughtSpot is valid for 5 minutes by default. You can configure the token expiration time as required.\n\n#### ABAC via RLS\n\nTo implement ABAC via RLS and assign security entitlements to users during session creation, generate a token with custom variable values. The values set in the authentication token are applied to the formula variables referenced in RLS rules at the table level, which determines the data each user can access based on their entitlements.\n\nThe variable values can be configured to persist for a specific set of Models in user sessions initiated with the token, allowing different RLS rules to be set for different data models. Once defined, the rules are added to the user's `variable_values` object, after which all sessions will use the persisted values.\n\nFor more information, see [ABAC via tokens Documentation](https://developers.thoughtspot.com/docs/abac-via-rls-variables).\n\n##### Formula variables\nBefore defining variable values, ensure the variables are created and available on your instance. To create a formula variable, you can use the **Create variable** (`/api/rest/2.0/template/variables/create`) REST API endpoint, with the variable `type` set as `Formula_Variable` in the API request.\n\nThe API doesn't support `\"persist_option\": \"RESET\"` and `\"persist_option\": \"NONE\"` when `variable_values` are defined in the request. If you are using `variable_values` for token generation, you must use other supported persist options such as `APPEND` or `REPLACE`.\n\nIf you want to use `RESET` or `NONE`, do not pass any `variable_values`. In such cases, `variable_values` will remain unaffected.\n\n#### Supported objects\n\nThe supported object type is `LOGICAL_TABLE`. When using `object_id` with `variable_values`, models are supported.\n\n#### Just-in-time provisioning\n\nFor [just-in-time user creation and provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisioning), specify the following attributes in the API request:\n\n* `auto_create`\n* `username`\n* `display_name`\n* `email`\n* `groups`\n\nSet `auto_create` to `true` if the username does not exist in ThoughtSpot. If the username already exists in ThoughtSpot and `auto_create` is set to `true`, user properties such as display name, email, Org and group entitlements will not be updated with new values. Setting `auto_create` to `true` does not create formula variables. Hence, this setting will not be applicable to `variable_values`.\n\n#### Important point to note\nAll options in the token creation APIs that define user access to data in ThoughtSpot will take effect during token creation, not when the token is used for authentication. For example, `auto_create:true` will create the user when the authentication token is created. Persist options such as `APPEND` and `REPLACE` will persist `variable_values` on the user profile when the token is created.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Authentication", "10.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCustomAccessTokenRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "ABAC token creation was successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessToken" }, "examples": { "example_1": { "description": "Custom access token with variable values and APPEND persist option for an existing user", "value": { "id": "9f8e7d6c-5b4a-3210-fedc-ba9876543210", "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example_custom_token.signature", "org": { "id": 0, "name": "Primary" }, "user": { "id": "59481331-ee53-42be-a548-bd87be6ddd4a", "name": "analyst_user" }, "creation_time_in_millis": 1724277430000, "expiration_time_in_millis": 1724277730000 } }, "example_2": { "description": "Custom access token with variable values for a JIT-provisioned user", "value": { "id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890", "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example_jit_custom_token.signature", "org": { "id": 1, "name": "SalesOrg" }, "user": { "id": "3f2e1d4c-9b8a-7e6f-5d4c-3b2a1e0f9d8c", "name": "new_sales_user@example.com" }, "creation_time_in_millis": 1724278000000, "expiration_time_in_millis": 1724278300000 } }, "example_3": { "description": "Org-scoped custom access token authorized for specific Orgs (Tenant Admin)", "value": { "id": "5c4b3a29-1807-4f6e-8d9c-abcdef012345", "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example_org_scoped_custom_token.signature", "org": { "id": 2, "name": "sales-org" }, "user": { "id": "59481331-ee53-42be-a548-bd87be6ddd4a", "name": "tsadmin" }, "creation_time_in_millis": 1724277430000, "expiration_time_in_millis": 1724277730000, "scope": { "org_scope": "SPECIFIC_ORGS", "org_ids": [ { "id": 2, "name": "sales-org" }, { "id": 3, "name": "marketing-org" } ] } } } } } } }, "400": { "description": "Invalid request. This could be due to missing or incorrect parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "Invalid persistOption: 'APPEND'. Expected: 'RESET' when resetOption is provided." } } } } } } } }, "401": { "description": "Unauthorized access. The request could not be authenticated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Invalid credentials. The provided secret key or password is incorrect." } } } } } } } }, "403": { "description": "Forbidden access. The user does not have permission to access this resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Trusted authentication is not enabled for this cluster or org." } } } } } } } }, "409": { "description": "Conflict. A concurrent update to the same template variable was detected and the request could not be applied. Retry the request after serializing concurrent variable updates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "An unexpected error occurred on the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while generating the custom access token." } } } } } } } } }, "security": [] } }, "/api/rest/2.0/auth/token/full": { "post": { "operationId": "getFullAccessToken", "description": "\n Version: 9.0.0.cl or later\n\nGenerates an authentication token for creating a full session in ThoughtSpot for a given user. Recommended for use cases that do not require Attribute-based access control (ABAC) via Row Level Security (RLS).\n\n#### Usage guidelines\n\nYou can generate a token for a user by providing a `username` and `password`, or by using the `secret_key` generated for your instance. To generate a `secret_key`, the administrator must enable [Trusted authentication](https://developers.thoughtspot.com/docs/trusted-auth-secret-key) in the **Develop** > **Customizations** > **Security Settings** page.\n\n**Note**:\n* When both `password` and `secret_key` are included in the API request, `secret_key` takes precedence.\n* If [Multi-Factor Authentication (MFA)](https://docs.thoughtspot.com/cloud/latest/authentication-local-mfa) is enabled on your instance, the API login request with `username` and `password` returns an error. You can switch to token-based authentication with `secret_key` or contact ThoughtSpot Support for assistance.\n\nThe token obtained from ThoughtSpot is valid for 5 minutes by default. You can configure the token expiration time as required.\n\n#### Just-in-time provisioning\n\nFor [just-in-time user creation and provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisioning), specify the following attributes in the API request:\n\n* `auto_create`\n* `username`\n* `display_name`\n* `email`\n* `group_identifiers`\n\nSet `auto_create` to `true` if the username does not exist in ThoughtSpot. If the user already exists in ThoughtSpot and `auto_create` is set to `true`, user properties such as display name, email and group assignment will be updated.\n\nTo add a new user and assign privileges during auto-creation, the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege is required. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CONTROL_TRUSTED_AUTH` (**Can Enable or Disable Trusted Authentication**) privilege is required.\n\n#### Important point to note\nAll options in the token creation APIs that define user access to data in ThoughtSpot will take effect during token creation, not when the token is used for authentication. For example, `auto_create:true` will create the user when the authentication token is created.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Authentication", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFullAccessTokenRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Bearer auth token creation successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Token" }, "examples": { "example_1": { "description": "Full-access token generated using cluster secret key", "value": { "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example_full_token.signature", "creation_time_in_millis": 1724277430000, "expiration_time_in_millis": 1724277730000, "scope": { "access_type": "FULL", "org_id": 0 }, "valid_for_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "valid_for_username": "tsadmin" } }, "example_2": { "description": "Full-access token for a JIT-provisioned user in a specific org", "value": { "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example_jit_full_token.signature", "creation_time_in_millis": 1724278000000, "expiration_time_in_millis": 1724278300000, "scope": { "access_type": "FULL", "org_id": 1 }, "valid_for_user_id": "b3d9e1f7-2a4c-4e8b-9d1f-6c5a3b8e7d2f", "valid_for_username": "jit_analyst@example.com" } }, "example_3": { "description": "Org-scoped full-access token authorized for specific Orgs (Tenant Admin)", "value": { "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example_org_scoped_full_token.signature", "creation_time_in_millis": 1724277430000, "expiration_time_in_millis": 1724277730000, "scope": { "access_type": "FULL", "org_id": 2, "org_scope": "SPECIFIC_ORGS", "org_ids": [ { "id": 2, "name": "sales-org" }, { "id": 3, "name": "marketing-org" } ] }, "valid_for_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "valid_for_username": "tsadmin" } }, "example_4": { "description": "Full-access token authorized for all member Orgs (Tenant Admin). The token is not bound to one Org, so org_id is -1 and org_ids is omitted.", "value": { "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example_all_orgs_token.signature", "creation_time_in_millis": 1724277430000, "expiration_time_in_millis": 1724277730000, "scope": { "access_type": "FULL", "org_id": -1, "org_scope": "ALL_MEMBER_ORGS" }, "valid_for_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "valid_for_username": "tsadmin" } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "Either secret_key or password must be provided." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Invalid credentials. The provided secret key or password is incorrect." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Trusted authentication is not enabled for this cluster or org." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while generating the full-access token." } } } } } } } } }, "security": [] } }, "/api/rest/2.0/auth/token/object": { "post": { "operationId": "getObjectAccessToken", "description": "\n Version: 9.0.0.cl or later\n\nGenerates an authentication token that provides access to a specific metadata object. This object list is intersected with the list of objects the user is allowed to access via group membership. For more information, see [Object security](https://docs.thoughtspot.com/cloud/latest/security-data-object#object_security).\n\n#### Usage guidelines\n\nYou can generate a token for a user by providing a `username` and `password`, or by using the `secret_key` generated for your instance. To generate a `secret_key`, the administrator must enable [Trusted authentication](https://developers.thoughtspot.com/docs/trusted-auth-secret-key) in the **Develop** > **Customizations** > **Security Settings** page.\n\n**Note**:\n* When both `password` and `secret_key` are included in the API request, `secret_key` takes precedence.\n* If [Multi-Factor Authentication (MFA)](https://docs.thoughtspot.com/cloud/latest/authentication-local-mfa) is enabled on your instance, the API login request with `username` and `password` returns an error. You can switch to token-based authentication with `secret_key` or contact ThoughtSpot Support for assistance.\n\nThe token obtained from ThoughtSpot is valid for 5 minutes by default. You can configure the token expiration time as required.\n\n#### Just-in-time provisioning\n\nFor [just-in-time user creation and provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisioning), specify the following attributes in the API request:\n\n* `auto_create`\n* `username`\n* `display_name`\n* `email`\n* `group_identifiers`\n\nSet `auto_create` to `true` if the user is not available in ThoughtSpot. If the user already exists in ThoughtSpot and the `auto_create` parameter is set to `true`, user properties such as display name, email, and group assignment will be updated.\n\nTo add a new user and assign privileges, the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege is required. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CONTROL_TRUSTED_AUTH`(**Can Enable or Disable Trusted Authentication**) privilege is required.\n\n#### Important point to note\n\nAll options in the token creation APIs that define user access to data in ThoughtSpot will take effect during token creation, not when the token is used for authentication. For example, `auto_create:true` will create the user when the authentication token is created.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Authentication", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetObjectAccessTokenRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Bearer auth token creation successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Token" }, "examples": { "example_1": { "description": "Object-scoped access token for a specific liveboard", "value": { "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example_object_token.signature", "creation_time_in_millis": 1724277430000, "expiration_time_in_millis": 1724277730000, "scope": { "access_type": "REPORT_BOOK_VIEW", "org_id": 0, "metadata_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479" }, "valid_for_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "valid_for_username": "tsadmin" } }, "example_2": { "description": "Object-scoped token with JIT user provisioning", "value": { "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example_jit_object_token.signature", "creation_time_in_millis": 1724278000000, "expiration_time_in_millis": 1724278300000, "scope": { "access_type": "REPORT_BOOK_VIEW", "org_id": 0, "metadata_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "valid_for_user_id": "7e4c9f2a-8b5d-4a1e-9c3b-6d8e2f5a7b4c", "valid_for_username": "new_user@example.com" } }, "example_3": { "description": "Org-scoped object access token authorized for specific Orgs (Tenant Admin)", "value": { "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.example_org_scoped_object_token.signature", "creation_time_in_millis": 1724277430000, "expiration_time_in_millis": 1724277730000, "scope": { "access_type": "REPORT_BOOK_VIEW", "org_id": 2, "metadata_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "org_scope": "SPECIFIC_ORGS", "org_ids": [ { "id": 2, "name": "sales-org" }, { "id": 3, "name": "marketing-org" } ] }, "valid_for_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "valid_for_username": "tsadmin" } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "Either secret_key or password must be provided." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Invalid credentials. The provided secret key or password is incorrect." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Trusted authentication is not enabled for this cluster or org." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while generating the object-scoped access token." } } } } } } } } }, "security": [] } }, "/api/rest/2.0/auth/session/login": { "post": { "operationId": "login", "description": "\n Version: 9.0.0.cl or later\n\nCreates a login session for a ThoughtSpot user with Basic authentication.\n\nIn Basic authentication method, REST clients log in to ThoughtSpot using `username` and `password` attributes. On a multi-tenant cluster with Orgs, users can pass the ID of the Org in the API request to log in to a specific Org context.\n\n**Note**: If Multi-Factor Authentication (MFA) is enabled on your instance, the API login request with basic authentication (`username` and `password` ) returns an error. Contact ThoughtSpot Support for assistance.\n\nA successful login returns a session cookie that can be used in your subsequent API requests.\n\n#### Redirecting after login\n\nTo send a browser to a specific page once the session is created, pass\n`redirect_url`. It must be a path on the same ThoughtSpot instance that served\nthe login request, for example `/pinboards`. An absolute URL is rejected with\n`400`, so that a login cannot be used to forward a newly issued session cookie\nto another host.\n\nThe path is resolved against the host the caller actually reached, which means\nthe same request works unchanged on a custom domain, behind a proxy, or on an\nOrg-specific subdomain.\n\n* **Browser flows** — omit `no_url_redirection`. The API answers `302` with the\n resolved path in the `location` header, and the browser follows it on its own.\n This is the usual choice when the login is submitted as an HTML form or opened\n as a top-level navigation.\n* **SPA and non-browser clients** — set `no_url_redirection` to `true`. The API\n keeps its normal `204` response and returns the resolved path in the\n `location` header without redirecting, leaving the client to decide when and\n where to navigate. Use this from `fetch`/`XMLHttpRequest` calls, which follow\n a `302` internally and never expose it to your code.\n\nWhen `redirect_url` is omitted the response is unchanged, and\n`no_url_redirection` has no effect on its own.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Authentication", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "User login successful." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "The specified org_identifier does not refer to a valid or accessible org." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication failed. Verify that the username and password are correct." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "User account is inactive or locked." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error during login." } } } } } } } } } } }, "/api/rest/2.0/auth/session/logout": { "post": { "operationId": "logout", "description": "\n Version: 9.0.0.cl or later\n\n\nLogs out a user from their current session.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Authentication", "9.0.0.cl" ], "parameters": [], "responses": { "204": { "description": "User logout successful." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "No active session found. User is not logged in." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error during logout." } } } } } } } } } } }, "/api/rest/2.0/auth/token/revoke": { "post": { "operationId": "revokeToken", "description": "\n Version: 9.0.0.cl or later\n\n\nRevokes the authentication token issued for current user session.\n\nThe token of your current session expires when you make a call to the `/api/rest/2.0/auth/token/revoke` endpoint.\nthe users will not be able to access ThoughtSpot objects until a new token is obtained.\n\nTo restart your session, request for a new token from ThoughtSpot. See [Get Full Access Token](#/http/api-endpoints/authentication/get-full-access-token).\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Authentication", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeTokenRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Token successfully revoked." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "Either user_identifier or token must be provided." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to revoke a token." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Insufficient privileges to revoke tokens for another user." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while revoking the token." } } } } } } } } } } }, "/api/rest/2.0/auth/search": { "post": { "operationId": "searchAuthSettings", "description": "\n Version: 26.6.0.cl or later\n\nVersion: 26.6.0.cl or later\n\nReturns the authentication configuration for the specified auth type at cluster and org level. Currently supports `TRUSTED_AUTH`.\n\n#### Required privileges\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `CONTROL_TRUSTED_AUTH` (**Can Enable or Disable Trusted Authentication**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CONTROL_TRUSTED_AUTH` privilege is required.\n\n#### Usage guidelines\n\nUse `scope` to control which level of settings are returned:\n- `CLUSTER` — Returns cluster-level authentication status and access tokens. Accessible only from the Primary Org.\n- `ORG` — Returns org-level authentication status and access tokens for the current Org. Requires the per-Org authentication feature to be enabled on your instance.\n- If `scope` is omitted, both cluster and org-level settings are returned based on the caller's org context and feature availability.\n\nThe `access_tokens` array in `cluster_preferences` or `org_preferences` is omitted when no token is configured at that level.\n\n**Note**: Access tokens returned in the response are sensitive credentials. Treat them with the same care as passwords.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Authentication", "26.6.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchAuthSettingsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Authentication settings retrieved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchAuthSettingsResponse" }, "examples": { "example_1": { "value": { "auth_type": "TRUSTED_AUTH", "cluster_preferences": { "auth_status": "ENABLED", "access_tokens": [ { "key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } ] }, "org_preferences": [ { "org": { "id": 583464508, "name": "sales_org" }, "auth_status": "ENABLED", "access_tokens": [ { "key": "f9e8d7c6-b5a4-3210-fedc-ba9876543210" } ] } ] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "auth_type must be specified and currently only TRUSTED_AUTH is supported." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to retrieve authentication settings." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "ADMINISTRATION or CONTROL_TRUSTED_AUTH privilege required to retrieve authentication settings." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while retrieving authentication settings." } } } } } } } } } } }, "/api/rest/2.0/auth/token/validate": { "post": { "operationId": "validateToken", "description": "\n Version: 9.12.0.cl or later\n\n\nValidates the authentication token specified in the API request.\n\nIf your token is not valid, [Get a new token](#/http/api-endpoints/authentication/get-full-access-token).\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Authentication", "9.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateTokenRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Token validation successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenValidationResponse" }, "examples": { "example_1": { "description": "Valid full-access token", "value": { "creation_time_in_millis": 1724277430000, "expiration_time_in_millis": 1724277730000, "scope": { "access_type": "FULL", "org_id": 0 }, "valid_for_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "token_type": "BEARER" } }, "example_2": { "description": "Valid object-scoped token", "value": { "creation_time_in_millis": 1724277430000, "expiration_time_in_millis": 1724277730000, "scope": { "access_type": "REPORT_BOOK_VIEW", "org_id": 0, "metadata_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479" }, "valid_for_user_id": "7e4c9f2a-8b5d-4a1e-9c3b-6d8e2f5a7b4c", "token_type": "BEARER" } }, "example_3": { "description": "Valid org-scoped token authorized for specific Orgs (Tenant Admin)", "value": { "creation_time_in_millis": 1724277430000, "expiration_time_in_millis": 1724277730000, "scope": { "access_type": "FULL", "org_id": 2, "org_scope": "SPECIFIC_ORGS", "org_ids": [ { "id": 2, "name": "sales-org" }, { "id": 3, "name": "marketing-org" } ] }, "valid_for_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "token_type": "BEARER" } }, "example_4": { "description": "Valid custom access (ABAC) token issued by POST /api/rest/2.0/auth/token/custom. Custom tokens are JWTs.", "value": { "creation_time_in_millis": 1724277430000, "expiration_time_in_millis": 1724277730000, "scope": { "access_type": "FULL", "org_id": 0 }, "valid_for_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "token_type": "JWT" } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "malformed_token": { "summary": "Malformed token", "description": "The token cannot be parsed. Both malformed and expired tokens return error code 10002 — the debug field distinguishes the root cause.", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "The provided token is malformed and cannot be parsed." } } } }, "expired_token": { "summary": "Expired token", "description": "The token signature is valid but the token has passed its expiration time. Both malformed and expired tokens return error code 10002 — the debug field distinguishes the root cause.", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcf-ef1234567891", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcf-ef1234567891", "debug": "The provided token has expired." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to validate a token." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while validating the token." } } } } } } } } } } }, "/api/rest/2.0/collections/create": { "post": { "operationId": "createCollection", "description": "\n Version: 26.4.0.cl or later\n\nCreates a new collection in ThoughtSpot.\n\nCollections allow you to organize and group related metadata objects such as Liveboards, Answers, worksheets, and other data objects. You can also create nested collections (sub-collections) to build a hierarchical structure.\n\n#### Supported operations\n\nThe API endpoint lets you perform the following operations:\n\n* Create a new collection\n* Add metadata objects (Liveboards, Answers, Logical Tables) to the collection\n* Create nested collections by adding sub-collections\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Collections", "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCollectionRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Collection created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Collection" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/collections/delete": { "post": { "operationId": "deleteCollection", "description": "\n Version: 26.4.0.cl or later\n\nDeletes one or more collections from ThoughtSpot.\n\n#### Delete options\n\n* **delete_children**: When set to `true`, deletes the child objects (metadata items) within the collection that the user has access to. Objects that the user does not have permission to delete will be skipped.\n* **dry_run**: When set to `true`, performs a preview of the deletion operation without actually deleting anything. The response shows what would be deleted, allowing you to review before committing the deletion.\n\n#### Response\n\nThe response includes:\n* **metadata_deleted**: List of metadata objects that were successfully deleted\n* **metadata_skipped**: List of metadata objects that were skipped due to lack of permissions or other constraints\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Collections", "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCollectionRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Collections deleted successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionDeleteResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/collections/search": { "post": { "operationId": "searchCollections", "description": "\n Version: 26.4.0.cl or later\n\nGets a list of collections available in ThoughtSpot.\n\nTo get details of a specific collection, specify the collection GUID or name. You can also filter the API response based on the collection name pattern, author, and other criteria.\n\n#### Search options\n\n* **name_pattern**: Use '%' as a wildcard character to match collection names\n* **collection_identifiers**: Search for specific collections by their GUIDs or names\n* **include_metadata**: When set to `true`, includes the metadata objects within each collection in the response\n\n**NOTE**: In addition to the GUID and name, `collection_identifiers` accepts a Custom object ID if one is configured for the collection. The response also includes the `obj_id` field for each collection that has one set.\n\n**Warning**: Do not set `record_size` to `-1`. On ThoughtSpot instances with a large number of objects or users, this can lead to slow responses, excessive logging, and out-of-memory failures. Specify an explicit `record_size` and iterate through pages programmatically.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Collections", "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCollectionsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Successfully retrieved list of collections", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionSearchResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/collections/{collection_identifier}/update": { "post": { "operationId": "updateCollection", "description": "\n Version: 26.4.0.cl or later\n\nUpdates an existing collection in ThoughtSpot.\n\n#### Supported operations\n\nThis API endpoint lets you perform the following operations:\n\n* Update collection name and description\n* Change visibility settings\n* Add metadata objects to the collection (operation: ADD)\n* Remove metadata objects from the collection (operation: REMOVE)\n* Replace all metadata objects in the collection (operation: REPLACE)\n\n#### Operation types\n\n* **ADD**: Adds the specified metadata objects to the existing collection without removing current items\n* **REMOVE**: Removes only the specified metadata objects from the collection\n* **REPLACE**: Replaces all existing metadata objects with the specified items (default behavior)\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Collections", "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCollectionRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "collection_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique GUID of the collection. Note: Collection names cannot be used as\nidentifiers since duplicate names are allowed." } ], "responses": { "204": { "description": "Collection updated successfully. No content returned." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/connection-configurations/search": { "post": { "operationId": "connectionConfigurationSearch", "description": "\n Version: 10.12.0.cl or later\n\nGets connection configuration objects.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\n#### Usage guidelines\n* To get a list of all configurations available in the ThoughtSpot system, send the API request with only the connection name or GUID in the request body.\n* To fetch details of a configuration object, specify the configuration object name or GUID.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connection Configurations", "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionConfigurationSearchRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Configuration fetched successfully.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionConfigurationResponse" } }, "examples": { "example": { "value": [ { "configuration_identifier": "7d6c5b4a-3e2f-4a1b-9c8d-7e6f5a4b3c2d", "name": "Sales Analysts Warehouse", "description": "Routes queries for sales analysts to a dedicated warehouse", "configuration": { "accountName": "", "user": "", "role": "", "warehouse": "" }, "policy_principals": [], "policy_processes": [], "policy_process_options": { "impersonate_user": "" }, "disabled": false, "data_warehouse_type": "SNOWFLAKE", "policy_type": "NO_POLICY", "same_as_parent": false } ] } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/connection-configurations/create": { "post": { "operationId": "createConnectionConfiguration", "description": "\n Version: 10.12.0.cl or later\n\nCreates an additional configuration to an existing connection to a data warehouse. \n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\n#### Usage guidelines\n\n * A JSON map of configuration attributes in `configuration`. The following example shows the configuration attributes:\n ```\n {\n \"user\":\"DEV_USER\",\n \"password\":\"TestConn123\",\n \"role\":\"DEV\",\n \"warehouse\":\"DEV_WH\"\n }\n ```\n\n* If the `policy_type` is `PRINCIPALS`, then `policy_principals` is a required field.\n* If the `policy_type` is `PROCESSES`, then `policy_processes` is a required field.\n* If the `policy_type` is `NO_POLICY`, then `policy_principals` and `policy_processes` are not required fields.\n\n#### Parameterized Connection Support\nFor parameterized connections that use OAuth authentication, only the same_as_parent and policy_process_options attributes are allowed in the API request. These attributes are not applicable to connections that are not parameterized.\n\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connection Configurations", "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnectionConfigurationRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Connection configuration successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionConfigurationResponse" }, "examples": { "example": { "value": { "configuration_identifier": "7d6c5b4a-3e2f-4a1b-9c8d-7e6f5a4b3c2d", "name": "Sales Analysts Warehouse", "description": "Routes queries for sales analysts to a dedicated warehouse", "configuration": { "user": "", "role": "", "warehouse": "" }, "policy_principals": [], "policy_processes": [], "policy_process_options": { "impersonate_user": "" }, "disabled": false, "data_warehouse_type": "SNOWFLAKE", "policy_type": "NO_POLICY", "same_as_parent": false } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/connection-configurations/delete": { "post": { "operationId": "deleteConnectionConfiguration", "description": "\n Version: 10.12.0.cl or later\n\nDeletes connection configuration objects.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connection Configurations", "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteConnectionConfigurationRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Connection Configurations successfully deleted." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/connection-configurations/{configuration_identifier}/update": { "post": { "operationId": "updateConnectionConfiguration", "description": "\n Version: 10.12.0.cl or later\n\nUpdates a connection configuration object.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\n#### Supported operations\nThis API endpoint lets you perform the following operations in a single API request:\n\n * Edit the name or description of the configuration\n * Edit the configuration properties\n * Edit the `policy_type`\n * Edit the type of authentication\n * Enable or disable a configuration\n\n#### Parameterized Connection Support\nFor parameterized oauth based connections, only the `same_as_parent` and `policy_process_options` attributes are allowed. These attributes are not applicable to connections that are not parameterized.\n\n **NOTE**: When updating a configuration where `disabled` is `true`, you must reset `disabled` to `true` in your update request payload. If not explicitly set again, the API will default `disabled` to `false`.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connection Configurations", "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectionConfigurationRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "configuration_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the configuration." } ], "responses": { "204": { "description": "Connection configuration successfully updated." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/connection/create": { "post": { "operationId": "createConnection", "description": "\n Version: 9.2.0.cl or later\n\nCreates a connection to a data warehouse for live query services.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\n#### Create a connection without tables\n\nTo create a connection without tables:\n\n1. Pass these parameters in your API request.\n * Name of the connection.\n * Type of the data warehouse to connect to.\n * A JSON map of configuration attributes in `data_warehouse_config`. The following example shows the configuration attributes for a SnowFlake connection:\n ```\n {\n \"configuration\":{\n \"accountName\":\"thoughtspot_partner\",\n \"user\":\"tsadmin\",\n \"password\":\"TestConn123\",\n \"role\":\"sysadmin\",\n \"warehouse\":\"MEDIUM_WH\"\n },\n \"authenticationType\": \"SERVICE_ACCOUNT\",\n \"databases\": [\"DB1\", \"DB2\"],\n \"externalDatabases\":[\n\n ]\n }\n ```\n2. Set `validate` to `false`.\n\n**NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type.\n\n#### Create a connection with tables\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) and `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege is required.\n\nTo create a connection with tables:\n\n1. Pass these parameters in your API request.\n* Name of the connection.\n* Type of the data warehouse to connect to.\n* A JSON map of configuration attributes, database details, and table properties in `data_warehouse_config` as shown in the following example:\n ```\n {\n \"configuration\":{\n \"accountName\":\"thoughtspot_partner\",\n \"user\":\"tsadmin\",\n \"password\":\"TestConn123\",\n \"role\":\"sysadmin\",\n \"warehouse\":\"MEDIUM_WH\"\n },\n \"authenticationType\": \"SERVICE_ACCOUNT\",\n \"databases\": [\"DB1\", \"DB2\", \"AllDatatypes\"],\n \"externalDatabases\":[\n {\n \"name\":\"AllDatatypes\",\n \"isAutoCreated\":false,\n \"schemas\":[\n {\n \"name\":\"alldatatypes\",\n \"tables\":[\n {\n \"name\":\"allDatatypes\",\n \"type\":\"TABLE\",\n \"description\":\"\",\n \"selected\":true,\n \"linked\":true,\n \"columns\":[\n {\n \"name\":\"CNUMBER\",\n \"type\":\"INT64\",\n \"canImport\":true,\n \"selected\":true,\n \"isLinkedActive\":true,\n \"isImported\":false,\n \"tableName\":\"allDatatypes\",\n \"schemaName\":\"alldatatypes\",\n \"dbName\":\"AllDatatypes\"\n },\n {\n \"name\":\"CDECIMAL\",\n \"type\":\"INT64\",\n \"canImport\":true,\n \"selected\":true,\n \"isLinkedActive\":true,\n \"isImported\":false,\n \"tableName\":\"allDatatypes\",\n \"schemaName\":\"alldatatypes\",\n \"dbName\":\"AllDatatypes\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ```\n2. Set `validate` to `true`.\n\n**NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type.\n\nThe optional `databases` property in `data_warehouse_config` accepts a list of database names. When specified, ThoughtSpot persists this list on the connection and uses it to scope metadata fetching to only the specified databases in subsequent table add and remove operations. If omitted, all databases in the data warehouse are accessible for metadata operations.\n\nThe `databases` and `externalDatabases` serve different purposes. `databases` is a flat list of database names that controls which databases are scanned during metadata operations. `externalDatabases` defines the full table hierarchy and determines which tables are linked into ThoughtSpot.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnectionRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Connection to the datasource successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnectionResponse" }, "examples": { "example": { "value": { "id": "5e6b4a3c-2f1d-4e8a-9b7c-0d1e2f3a4b5c", "name": "Snowflake Sales", "data_warehouse_type": "SNOWFLAKE", "details": { "name": "Snowflake Sales", "description": "Snowflake connection for the sales warehouse", "type": "RDBMS_SNOWFLAKE", "id": "5e6b4a3c-2f1d-4e8a-9b7c-0d1e2f3a4b5c", "scheduled": false, "configuration": "{\"accountName\":\"\",\"user\":\"\",\"role\":\"\",\"warehouse\":\"\"}", "isExternal": false, "isDeprecated": false, "isDeleted": false, "isHidden": false, "indexVersion": 1, "generationNum": 1, "created": 1760198400000, "modified": 1760198400000, "author": { "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "name": "" }, "modifiedBy": { "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "name": "" }, "owner": { "id": "5e6b4a3c-2f1d-4e8a-9b7c-0d1e2f3a4b5c", "name": "Snowflake Sales" }, "tags": [], "tables": [ { "name": "allDatatypes", "type": "ONE_TO_ONE_LOGICAL", "id": "6f7a8b9c-0d1e-4f2a-8b3c-4d5e6f7a8b9c", "schemaStripe": "alldatatypes", "databaseStripe": "AllDatatypes", "isExternal": true, "isDeprecated": false, "isDeleted": false, "isHidden": false, "indexVersion": 1, "generationNum": 1, "created": 1760198400000, "modified": 1760198400000, "author": { "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "name": "" }, "modifiedBy": { "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "name": "" }, "owner": { "id": "6f7a8b9c-0d1e-4f2a-8b3c-4d5e6f7a8b9c", "name": "allDatatypes" }, "tags": [] } ] } } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/connection/delete": { "post": { "operationId": "deleteConnection", "description": "\n Version: 9.2.0.cl or later\n\n\n**Important**: This endpoint is deprecated and will be removed from ThoughtSpot in September 2025. ThoughtSpot strongly recommends using the\n[Delete Connection V2](#/http/api-endpoints/connections/delete-connection-v2) endpoint to delete your connection objects. \n\n#### Usage guidelines\n\nDeletes a connection object.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\n**Note**: If a connection has dependent objects, make sure you remove its associations before the delete operation.\n\n\n\n#### Endpoint URL\n", "deprecated": true, "tags": [ "Connections", "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteConnectionRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Connection successfully deleted." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/connections/{connection_identifier}/delete": { "post": { "operationId": "deleteConnectionV2", "description": "\n Version: 10.4.0.cl or later\n\nDeletes a connection object.\n\n**Note**: If a connection has dependent objects, make sure you remove its associations before the delete operation.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", "10.4.0.cl" ], "parameters": [ { "in": "path", "name": "connection_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the connection." } ], "responses": { "204": { "description": "Connection successfully deleted." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/connections/download-connection-metadata-changes/{connection_identifier}": { "post": { "operationId": "downloadConnectionMetadataChanges", "description": "\n Version: 9.9.0.cl or later\n\nExports the difference in connection metadata between CDW and ThoughtSpot\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: \n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\nTo download the connection metadata difference between ThoughtSpot and CDW, pass the connection GUID as `connection_identifier` in the API request.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", "9.9.0.cl" ], "parameters": [ { "in": "path", "name": "connection_identifier", "required": true, "schema": { "type": "string" }, "description": "GUID of the connection" } ], "responses": { "200": { "description": "Export metadata changes.", "content": { "application/octet-stream": {} } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/connections/fetch-connection-diff-status/{connection_identifier}": { "post": { "operationId": "fetchConnectionDiffStatus", "description": "\n Version: 9.9.0.cl or later\n\nValidates the difference in connection metadata between CDW and ThoughtSpot.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n\n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\nReturns a boolean indicating whether there is any difference between the connection metadata at ThoughtSpot and CDW.\n\nTo get the connection metadata difference status, pass the connection GUID as `connection_identifier` in the API request.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", "9.9.0.cl" ], "parameters": [ { "in": "path", "name": "connection_identifier", "required": true, "schema": { "type": "string" }, "description": "GUID of the connection" } ], "responses": { "200": { "description": "true/false", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchConnectionDiffStatusResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/connections/{connection_identifier}/revoke-refresh-tokens": { "post": { "operationId": "revokeRefreshTokens", "description": "\n Version: 26.2.0.cl or later\n\nRevokes OAuth refresh tokens for users who no longer require access to a data warehouse connection.\nWhen a token is revoked, the affected user's session for that connection is terminated, and they must re-authenticate to regain access.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DATAMANAGEMENT` (**Can manage data**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on the ThoughtSpot instance, users with `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege can also make API requests to revoke tokens for connection users.\n\n#### Usage guidelines\n\nYou can specify different combinations of identifiers to control which refresh tokens are revoked.\n\n- **connection_identifier**: Revokes refresh tokens for all users of the connection, except the connection author.\n- **connection_identifier** and **user_identifiers**: Revokes refresh tokens only for the users specified in the request. If the name or ID of the connection author is included in the request, their token will also be revoked.\n- **connection_identifier** and **configuration_identifiers**: Revokes refresh tokens for all users on the specified configurations, except the configuration author.\n- **connection_identifier**, **configuration_identifiers**, and **user_identifiers**: Revokes refresh tokens for the specified users on the specified configurations.\n- **connection_identifier** and **org_identifiers**: Revokes refresh tokens for the specified Orgs. Applicable only for published connections.\n- **connection_identifier**, **org_identifiers**, and **user_identifiers**: Revokes refresh tokens for the specified users in the specified Orgs. Applicable only for published connections.\n\n**NOTE**: The `org_identifiers` parameter is only applicable for published connections. Using this parameter for unpublished connections will result in an error. Ensure that the connections are published before making the API request.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", "26.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeRefreshTokensRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "connection_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the connection whose refresh tokens need to be revoked. All the users associated with the connection will have their refresh tokens revoked except the author." } ], "responses": { "200": { "description": "Token(s) successfully revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeRefreshTokensResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Object not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/connection/search": { "post": { "operationId": "searchConnection", "description": "\n Version: 9.2.0.cl or later\n\nGets connection objects.\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\n- To get a list of all connections available in the ThoughtSpot system, send the API request without any attributes in the request body.\n- To get the connection objects for a specific type of data warehouse, specify the type in `data_warehouse_types`.\n- To fetch details of a connection object, specify the connection object GUID or name. The `name_pattern` attribute allows passing partial text with `%` for a wildcard match.\n- To get details of the database, schemas, tables, or columns from a data connection object, specify `data_warehouse_object_type`.\n- To get a specific database, schema, table, or column from a connection object, define the object type in `data_warehouse_object_type` and object properties in the `data_warehouse_objects` array. For example, to search for a column, you must pass the database, schema, and table names in the API request.\n Note that in the following example, object properties are set in a hierarchical order (`database` > `schema` > `table` > `column`).\n\n```\n{\n \"connections\": [\n {\n \"identifier\": \"b9d1f2ef-fa65-4a4b-994e-30fa2d57b0c2\",\n \"data_warehouse_objects\": [\n {\n \"database\": \"NEBULADEV\",\n \"schema\": \"INFORMATION_SCHEMA\",\n \"table\": \"APPLICABLE_ROLES\",\n \"column\": \"ROLE_NAME\"\n }\n ]\n }\n ],\n \"data_warehouse_object_type\": \"COLUMN\"\n}\n```\n\n- To fetch data by `configuration`, specify `data_warehouse_object_type`. For example, to fetch columns from the `DEVELOPMENT` database, specify the `data_warehouse_object_type` as `DATABASE` and define the `configuration` string as `{\"database\":\"DEVELOPMENT\"}`. To get column data for a specific table, specify the table, for example,`{\"database\":\"RETAILAPPAREL\",\"table\":\"PIPES\"}`.\n- To query connections by `authentication_type`, specify `data_warehouse_object_type`. Supported values for `authentication_type` are:\n - `SERVICE_ACCOUNT`: For connections that require service account credentials to authenticate to the Cloud Data Warehouse and fetch data.\n - `OAUTH`: For connections that require OAuth credentials to authenticate to the Cloud Data Warehouse and fetch data. Teradata, Oracle, and Presto Cloud Data Warehouses do not support the OAuth authentication type.\n - `IAM`: For connections that have the IAM OAuth set up. This authentication type is supported on Amazon Redshift connections only.\n - `EXTOAUTH`: For connections that have External OAuth set up. ThoughtSpot supports external [OAuth with Microsoft Azure Active Directory (AD)](https://docs.thoughtspot.com/cloud/latest/ connections-snowflake-azure-ad-oauth) and [Okta for Snowflake data connections](https://docs.thoughtspot.com/cloud/latest/connections-snowflake-okta-oauth).\n - `KEY_PAIR`: For connections that require Key Pair account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only.\n - `OAUTH_WITH_PKCE`: For connections that require OAuth with PKCE account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake, Starburst, Databricks, Denodo connections only.\n - `EXTOAUTH_WITH_PKCE`: For connections that require External OAuth With PKCE account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only.\n - `OAUTH_WITH_PEZ`: For connections that require OAuth With PEZ account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Amazon Redshift connections only.\n - `OAUTH_WITH_SERVICE_PRINCIPAL`: For connections that require OAuth With Service Principal account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Databricks connections only.\n - `PERSONAL_ACCESS_TOKEN`: For connections that require Personal Access Token account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Databricks connections only.\n - `OAUTH_CLIENT_CREDENTIALS`: For connections that require OAuth Client Credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only.\n- To include more details about connection objects in the API response, set `include_details` to `true`.\n- You can also sort the output by field names and filter connections by tags.\n\n**NOTE**: In addition to the connection GUID and name, the `identifier` field on each entry in `connections` accepts a Custom object ID if one is configured for the connection. The response also includes the `obj_id` field for each connection that has one set.\n\n**NOTE**: When filtering connection records by parameters other than `data_warehouse_types` or `tag_identifiers`, ensure that you set `record_size` to `-1` and `record_offset` to `0` for precise results.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchConnectionRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "List of connections to the datasource.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SearchConnectionResponse" } }, "examples": { "example": { "value": [ { "id": "5e6b4a3c-2f1d-4e8a-9b7c-0d1e2f3a4b5c", "obj_id": "5e6b4a3c-2f1d-4e8a-9b7c-0d1e2f3a4b5c", "name": "Snowflake Sales", "description": "Snowflake connection for the sales warehouse", "data_warehouse_type": "SNOWFLAKE", "data_warehouse_objects": { "databases": [ { "name": "SALES_DB", "auto_created": false, "schemas": [ { "name": "PUBLIC", "tables": [ { "name": "ORDERS", "type": "TABLE", "description": "", "selected": true, "linked": true, "columns": [ { "name": "ORDER_ID", "data_type": "INT64", "can_import": true, "selected": true, "is_linked_active": true }, { "name": "CUSTOMER_ID", "data_type": "INT64", "can_import": true, "selected": true, "is_linked_active": true } ], "relationships": [ { "name": "FK_ORDERS_CUSTOMERS", "destDatabase": "SALES_DB", "destSchema": "PUBLIC", "destTable": "CUSTOMERS", "relationshipKeys": [ { "sourceColumnName": "CUSTOMER_ID", "destColumnName": "CUSTOMER_ID" } ] } ] } ] } ] } ] }, "details": { "name": "Snowflake Sales", "description": "Snowflake connection for the sales warehouse", "type": "RDBMS_SNOWFLAKE", "id": "5e6b4a3c-2f1d-4e8a-9b7c-0d1e2f3a4b5c", "scheduled": false, "configuration": "{\"accountName\":\"\",\"user\":\"\",\"role\":\"\",\"warehouse\":\"\"}", "isExternal": false, "isDeprecated": false, "isDeleted": false, "isHidden": false, "indexVersion": 2, "generationNum": 2, "created": 1760198400000, "modified": 1760198460000, "author": { "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "name": "" }, "modifiedBy": { "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "name": "" }, "owner": { "id": "5e6b4a3c-2f1d-4e8a-9b7c-0d1e2f3a4b5c", "name": "Snowflake Sales" }, "tags": [ { "id": "3f2a1b0c-9d8e-4f7a-8b6c-5d4e3f2a1b0c", "name": "Finance" } ], "tables": [ { "name": "ORDERS", "type": "ONE_TO_ONE_LOGICAL", "id": "8c7b6a5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d", "schemaStripe": "PUBLIC", "databaseStripe": "SALES_DB", "isExternal": true, "isDeprecated": false, "isDeleted": false, "isHidden": false, "indexVersion": 1, "generationNum": 1, "created": 1760198460000, "modified": 1760198460000, "author": { "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "name": "" }, "modifiedBy": { "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "name": "" }, "owner": { "id": "8c7b6a5d-4e3f-4a2b-9c1d-0e9f8a7b6c5d", "name": "ORDERS" }, "tags": [] } ] } } ] } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/connections/{connection_identifier}/resync-metadata": { "post": { "operationId": "syncMetadata", "description": "\n Version: 26.5.0.cl or later\n\nSynchronizes connection metadata attributes from your Cloud Data Warehouse (CDW) with ThoughtSpot.\n\nRequires the `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege is required.\n\n#### Usage guidelines\n\nTo synchronize attributes from a CDW, specify the connection GUID or name in the `connection_identifier` path parameter and `sync_attributes` in the request body. Default attribute is `[\"DESCRIPTION\"]`.\n\n##### Hierarchical schema\n\n* Connection: The connection object for the sync operation.\n* Tables: Tables for the sync operation. When no table is specified, all tables are synchronized.\n* Columns: If the table is specified, you can add the columns for the sync operation. If no columns are specified, all columns in the specified table are considered for the sync operation.\n\nTo set the scope for the sync operation:\n\n* Connection-level: To sync all tables and columns, pass an empty request body, or only the attributes in the request body.\n* Table-level: To synchronize specific tables and their columns, specify the table identifiers in the `tables` array.\n* Column-level: To synchronize specific columns, specify the table identifier as the key and column identifiers as the value in the `tables` array.\n\n```\n{\n \"tables\": [\n {\"table-guid-1\": [\"column-guid-1\", \"column-guid-2\"]},\n \"table-guid-2\"\n ],\n \"sync_attributes\": [\"DESCRIPTION\"]\n}\n```\n\n##### API response\n\nIf the sync operation is successful, the API returns the following information:\n\n* Status of the sync operation. For example, `SUCCESS`, `PARTIAL_SUCCESS`, or `NO_UPDATE`.\n* Number of tables and columns that were updated.\n* Number of tables and columns with the sync failed status when the overall sync status is `PARTIAL_SUCCESS`.\n* Message text indicating the sync results.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", "26.5.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncMetadataRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "connection_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the connection." } ], "responses": { "200": { "description": "Metadata synced successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncMetadataResponse" } } } }, "400": { "description": "Invalid request parameters or hierarchy.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Connection, table, or column not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/connection/update": { "post": { "operationId": "updateConnection", "description": "\n Version: 9.2.0.cl or later\n\n**Important**: This endpoint is deprecated and will be removed from ThoughtSpot in September 2025. ThoughtSpot strongly recommends using the\n[Update connection V2](#/http/api-endpoints/connections/update-connection-v2) endpoint to update your connection objects.\n\n#### Usage guidelines\n\nUpdates a connection object. \n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\nTo update a connection object, pass these parameters in your API request:\n\n1. GUID of the connection object.\n2. If you are updating tables or database schema of a connection object:\n a. Add the updated JSON map of metadata with database, schema, and tables in `data_warehouse_config`.\n b. Set `validate` to `true`.\n3. If you are updating a configuration attribute, connection name, or description, you can set `validate` to `false`.\n\n\n\n\n#### Endpoint URL\n", "deprecated": true, "tags": [ "Connections", "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectionRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Connection successfully updated." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/connections/{connection_identifier}/status": { "post": { "operationId": "updateConnectionStatus", "description": "\n Version: 26.6.0.cl or later\n\nActivates or deactivates a connection. A deactivated connection cannot be used for queries or operations until it is activated again.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. Only the connection owner or an administrator can perform this operation.\n\n#### Usage guidelines\n\nTo update the status of a connection, specify the connection GUID or name in the `connection_identifier` path parameter and the desired `status` in the request body.\n\n- **ACTIVATED**: Enables the connection. Queries and operations can resume on an activated connection.\n- **DEACTIVATED**: Disables the connection. It does not remove the connection metadata, but only makes the connection unavailable for queries and operations. You can reactivate a deactivated connection by setting \"status\": \"ACTIVATED\".\n\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", "26.6.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectionStatusRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "connection_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the connection." } ], "responses": { "204": { "description": "Connection status updated successfully." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Object not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/connections/{connection_identifier}/update": { "post": { "operationId": "updateConnectionV2", "description": "\n Version: 10.4.0.cl or later\n\nUpdates a connection object.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required.\n\nTo update a connection object, pass these parameters in your API request:\n\n1. GUID of the connection object.\n2. If you are updating tables or database schema of a connection object:\n a. Add the updated JSON map of metadata with database, schema, and tables in `data_warehouse_config`.\n b. Set `validate` to `true`.\n \n **NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type.\n\n * A JSON map of configuration attributes, database details, and table properties in `data_warehouse_config` as shown in the following example:\n * This is an example of updating a single table in a empty connection:\n \n ```\n {\n \"authenticationType\": \"SERVICE_ACCOUNT\",\n \"databases\": [\"DB2\", \"DB3\", \"DEVELOPMENT\"],\n \"externalDatabases\": [\n {\n \"name\": \"DEVELOPMENT\",\n \"isAutoCreated\": false,\n \"schemas\": [\n {\n \"name\": \"TS_dataset\",\n \"tables\": [\n {\n \"name\": \"DEMORENAME\",\n \"type\": \"TABLE\",\n \"description\": \"\",\n \"selected\": true,\n \"linked\": true,\n \"gid\": 0,\n \"datasetId\": \"-1\",\n \"subType\": \"\",\n \"reportId\": \"\",\n \"viewId\": \"\",\n \"columns\": [\n {\n \"name\": \"Col1\",\n \"type\": \"VARCHAR\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"Col2\",\n \"type\": \"VARCHAR\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"Col3\",\n \"type\": \"VARCHAR\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"Col312\",\n \"type\": \"VARCHAR\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"Col4\",\n \"type\": \"VARCHAR\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n }\n ],\n \"relationships\": []\n }\n ]\n }\n ]\n }\n ],\n \"configuration\": {\n \"password\": \"\",\n \"database\": \"DEVELOPMENT\",\n \"role\": \"DEV\",\n \"accountName\": \"thoughtspot_partner\",\n \"warehouse\": \"DEMO_WH\",\n \"user\": \"DEV_USER\"\n }\n }\n ```\n \n* This is an example of updating a single table in an existing connection with tables:\n \n ```\n {\n \"authenticationType\": \"SERVICE_ACCOUNT\",\n \"databases\": [\"DB2\", \"DB3\", \"DEVELOPMENT\"],\n \"externalDatabases\": [\n {\n \"name\": \"DEVELOPMENT\",\n \"isAutoCreated\": false,\n \"schemas\": [\n {\n \"name\": \"TS_dataset\",\n \"tables\": [\n {\n \"name\": \"CUSTOMER\",\n \"type\": \"TABLE\",\n \"description\": \"\",\n \"selected\": true,\n \"linked\": true,\n \"gid\": 0,\n \"datasetId\": \"-1\",\n \"subType\": \"\",\n \"reportId\": \"\",\n \"viewId\": \"\",\n \"columns\": [],\n \"relationships\": []\n },\n {\n \"name\": \"tpch5k_falcon_default_schema_users\",\n \"type\": \"TABLE\",\n \"description\": \"\",\n \"selected\": true,\n \"linked\": true,\n \"gid\": 0,\n \"datasetId\": \"-1\",\n \"subType\": \"\",\n \"reportId\": \"\",\n \"viewId\": \"\",\n \"columns\": [\n {\n \"name\": \"user_id\",\n \"type\": \"INT64\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"product_id\",\n \"type\": \"INT64\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n },\n {\n \"name\": \"user_cost\",\n \"type\": \"INT64\",\n \"canImport\": true,\n \"selected\": true,\n \"description\": \"\",\n \"isLinkedActive\": true,\n \"isAggregate\": false\n }\n ],\n \"relationships\": []\n }\n ]\n }\n ]\n }\n ],\n \"configuration\": {\n \"password\": \"\",\n \"database\": \"DEVELOPMENT\",\n \"role\": \"DEV\",\n \"accountName\": \"thoughtspot_partner\",\n \"warehouse\": \"DEMO_WH\",\n \"user\": \"DEV_USER\"\n }\n }\n ```\n\n3. If you are updating a configuration attribute, connection name, or description, you can set `validate` to `false`.\n\n **NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type.\n\n * A JSON map of configuration attributes in `data_warehouse_config`. The following example shows the configuration attributes for a Snowflake connection:\n ```\n {\n \"configuration\":{\n \"accountName\":\"thoughtspot_partner\",\n \"user\":\"tsadmin\",\n \"password\":\"TestConn123\",\n \"role\":\"sysadmin\",\n \"warehouse\":\"MEDIUM_WH\"\n },\n \"databases\":[\"DB1\", \"DB2\"],\n \"externalDatabases\":[\n\n ]\n }\n ```\n\nThe optional `databases` property in `data_warehouse_config` accepts a list of database names. When specified, ThoughtSpot persists this list on the connection and uses it to scope metadata fetching to only the specified databases in subsequent table add and remove operations. If omitted, all databases in the data warehouse are accessible for metadata operations.\n\nThe `databases` and `externalDatabases` serve different purposes. `databases` is a flat list of database names that controls which databases are scanned during metadata operations. `externalDatabases` defines the full table hierarchy and determines which tables are linked into ThoughtSpot.\n\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Connections", "10.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConnectionV2Request" } } }, "required": true }, "parameters": [ { "in": "path", "name": "connection_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the connection." } ], "responses": { "204": { "description": "Connection successfully updated." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/customization/custom-actions": { "post": { "operationId": "createCustomAction", "description": "\n Version: 9.6.0.cl or later\n\n**Note:** This API endpoint is deprecated from 26.12.0.cl and will be removed from ThoughtSpot in 27.6.0.cl. Use [code-based custom actions](https://developers.thoughtspot.com/docs/code-based-custom-action) in the Visual Embed SDK instead.\n\nCreates a custom action that appears as a menu action on a saved Answer or Liveboard visualization.\n\nRequires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n#### Usage Guidelines\n\nThe API lets you create the following types of custom actions:\n\n* URL-based action \n Allows pushing data to an external URL.\n* Callback action \n Triggers a callback to the host application and initiates a response payload on an embedded ThoughtSpot instance.\n\nBy default, custom actions are visible to only administrator or developer users. To make a custom action available to other users, and specify the groups in `group_identifiers`.\n\nBy default, the custom action is set as a _global_ action on all visualizations and saved Answers. To assign a custom action to specific Liveboard visualization, saved Answer, or Worksheet, set `visibility` to `false` in `default_action_config` property and specify the GUID or name of the object in `associate_metadata`.\n\nFor more information, see [Custom actions](https://developers.thoughtspot.com/docs/custom-action-intro).\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Custom Action", "9.6.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomActionRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Custom action created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseCustomAction" }, "examples": { "example_1": { "value": { "action_details": { "CALLBACK": { "reference": "customaction" } }, "default_action_config": { "visibility": true }, "id": "3d3cad0f-e57b-4faa-8e24-da596c727ee0", "metadata_association": [], "name": "customactionsample", "user_groups": [] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "A custom action with the same name already exists. The custom action name must be unique." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to create a custom action." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Insufficient privileges to create custom actions." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while creating the custom action." } } } } } } } } } } }, "/api/rest/2.0/customization/custom-actions/{custom_action_identifier}/delete": { "post": { "operationId": "deleteCustomAction", "description": "\n Version: 9.6.0.cl or later\n\n**Note:** This API endpoint is deprecated from 26.12.0.cl and will be removed from ThoughtSpot in 27.6.0.cl. Use [code-based custom actions](https://developers.thoughtspot.com/docs/code-based-custom-action) in the Visual Embed SDK instead.\n\nRemoves the custom action specified in the API request.\n\nRequires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Custom Action", "9.6.0.cl" ], "parameters": [ { "in": "path", "name": "custom_action_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the custom action." } ], "responses": { "204": { "description": "Custom action is successfully deleted." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "Custom action with the specified identifier was not found." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to delete a custom action." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Insufficient privileges to delete custom actions." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while deleting the custom action." } } } } } } } } } } }, "/api/rest/2.0/customization/custom-actions/search": { "post": { "operationId": "searchCustomActions", "description": "\n Version: 9.6.0.cl or later\n\n**Note:** This API endpoint is deprecated from 26.12.0.cl and will be removed from ThoughtSpot in 27.6.0.cl. Use [code-based custom actions](https://developers.thoughtspot.com/docs/code-based-custom-action) in the Visual Embed SDK instead.\n\nGets custom actions configured on the cluster.\n\nRequires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Custom Action", "9.6.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCustomActionsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Custom action search is successful.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseCustomAction" } }, "examples": { "example_1": { "value": [ { "action_details": { "CALLBACK": { "reference": "LEDE" } }, "default_action_config": { "visibility": true }, "id": "c59262df-cf9e-4947-96fa-52d494688797", "name": "LEDE" } ] } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "Custom action identifier is invalid or malformed." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to search custom actions." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while searching custom actions." } } } } } } } } } } }, "/api/rest/2.0/customization/custom-actions/{custom_action_identifier}/update": { "post": { "operationId": "updateCustomAction", "description": "\n Version: 9.6.0.cl or later\n\n**Note:** This API endpoint is deprecated from 26.12.0.cl and will be removed from ThoughtSpot in 27.6.0.cl. Use [code-based custom actions](https://developers.thoughtspot.com/docs/code-based-custom-action) in the Visual Embed SDK instead.\n\nUpdates a custom action.\n\nRequires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n#### Usage Guidelines\n\nThe API allows you to modify the following properties:\n\n* Name of the custom action\n* Action availability to groups\n* Association to metadata objects\n* Authentication settings for a URL-based action\n\nFor more information, see [Custom actions](https://developers.thoughtspot.com/docs/custom-action-intro).\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Custom Action", "9.6.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomActionRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "custom_action_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the custom action." } ], "responses": { "204": { "description": "Custom action updated successfully." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "Custom action with the specified identifier was not found." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to update a custom action." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Insufficient privileges to update custom actions." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while updating the custom action." } } } } } } } } } } }, "/api/rest/2.0/calendars/create": { "post": { "operationId": "createCalendar", "description": "\n Version: 10.12.0.cl or later\n\nCreates a new [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal).\n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required.\n\n\n#### Usage guidelines\n\nYou can create a custom calendar from scratch or an existing Table in ThoughtSpot. For both methods of calendar creation, the following parameters are required:\n\n* Name of the custom calendar.\n* Calendar creation method. To create a calendar from an existing table, specify the method:\n\n - `FROM_EXISTING_TABLE` - Creates calendar from the table reference provided in the API request.\n - `FROM_INPUT_PARAMS` - Creates a calendar from the parameters defined in the API request.\n\n* Connection ID and Table name\n* Database and schema name attributes:\n For most Cloud Data Warehouse (CDW) connectors, both `database_name` and `schema_name` attributes are required. \n However, the attribute requirements are conditional and vary based on the connector type and its metadata structure. For example, for connectors such as Teradata, MySQL, SingleSore, Amazon Aurora MySQL, Amazon RDS MySQL, Oracle, and GCP_MYSQL, the `schema_name` is required, whereas the `database_name` attribute is not.\n Similarly, connectors such as ClickHouse require you to specify the `database_name` and the schema specification in such cases is optional.\n\n**NOTE**: If you are creating a calendar from an existing table, ensure that the referenced table matches the required DDL for custom calendars. If the schema does not match, the API returns an error.\n\n##### Calendar type\nThe API allows you to create the following types of calendars:\n\n* `MONTH_OFFSET`. The default calendar type. A `MONTH_OFFSET` calendar is offset by a few months from the standard calendar months (January to December) and the year begins with the month defined in the request. For example, if the `month_offset` value is set as `April`, the calendar year begins in April.\n\n* `4-4-5`. Each quarter in the calendar will include two 4-week months followed by one 5-week month.\n* `4-5-4`. Each quarter in the calendar will include two 4-week months with a 5-week month between.\n* `5-4-4`. Each quarter begins with a 5-week month, followed by two 4-week months.\n\nTo start and end the calendar on a specific date, specify the dates in the `MM/DD/YYYY` format. For `MONTH_OFFSET` calendars, ensure that the `start_date` matches the month specified in the `month_offset` attribute.\n\nYou can also set the starting day of the week and customize the prefixes for year and quarter labels.\n\n#### Examples\n\nTo create a calendar from an existing table:\n\n```\n{\n \"name\": \"MyCustomCalendar1\",\n \"table_reference\": {\n \"connection_identifier\": \"4db8ea22-2ff4-4224-b05a-26674717e468\",\n \"table_name\": \"MyCalendarTable\",\n \"database_name\": \"RETAILAPPAREL\",\n \"schema_name\": \"PUBLIC\"\n },\n \"creation_method\": \"FROM_EXISTING_TABLE\",\n}\n```\n\nTo create a calendar from scratch:\n\n```\n{\n \"name\": \"MyCustomCalendar1\",\n \"table_reference\": {\n \"connection_identifier\": \"4db8ea22-2ff4-4224-b05a-26674717e468\",\n \"table_name\": \"MyCalendarTable\",\n \"database_name\": \"RETAILAPPAREL\",\n \"schema_name\": \"PUBLIC\"\n },\n \"creation_method\": \"FROM_INPUT_PARAMS\",\n \"calendar_type\": \"MONTH_OFFSET\",\n \"month_offset\": \"April\",\n \"start_day_of_week\": \"Monday\",\n \"quarter_name_prefix\": \"Q\",\n \"year_name_prefix\": \"FY\",\n \"start_date\": \"04/01/2025\",\n \"end_date\": \"04/31/2025\"\n}\n```\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Custom Calendars", "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCalendarRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Custom calendar created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/calendars/{calendar_identifier}/delete": { "post": { "operationId": "deleteCalendar", "description": "\n Version: 10.12.0.cl or later\n\nDeletes a [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal).\n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required.\n\n#### Usage guidelines\nTo delete a custom calendar, specify the calendar ID as a path parameter in the request URL. \n\n\n\n\n#### Endpoint URL\n", "tags": [ "Custom Calendars", "10.12.0.cl" ], "parameters": [ { "in": "path", "name": "calendar_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the Calendar." } ], "responses": { "204": { "description": "Custom calendar successfully deleted." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/calendars/generate-csv": { "post": { "operationId": "generateCSV", "description": "\n Version: 10.12.0.cl or later\n\nExports a [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal) in the CSV format.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required.\n\n#### Usage guidelines\n\nUse this API to download a custom calendar in the CSV file format. In your API request, specify the following parameters.\n\n* Start and end date of the calendar. For \"month offset\" calendars, the start date must match the month defined in the `month_offset` attribute.\n\nYou can also specify optional parameters such as the starting day of the week and prefixes for the quarter and year labels.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Custom Calendars", "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateCSVRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Generate custom calendar data based on specifications, as a CSV file.", "headers": { "Content-Disposition": { "description": "Indicates that the response is a file attachment.", "schema": { "type": "string", "example": "attachment; filename=\"table_name.calendar.csv\"" } } }, "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/calendars/search": { "post": { "operationId": "searchCalendars", "description": "\n Version: 10.12.0.cl or later\n\nGets a list of [custom calendars](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal).\n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required.\n\n#### Usage guidelines\n\nBy default, the API returns a list of custom calendars for all connection objects. To retrieve custom calendar details for a particular connection, specify the connection ID. You can also use other search parameters such as `name_pattern` and `sort_options` as search filters.\n\nThe `name_pattern` parameter filters and returns only those objects that match the specified pattern. Use `%` as a wildcard for pattern matching.\n\n**Warning**: Do not set `record_size` to `-1`. On ThoughtSpot instances with a large number of objects or users, this can lead to slow responses, excessive logging, and out-of-memory failures. Specify an explicit `record_size` and iterate through pages programmatically.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Custom Calendars", "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCalendarsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Custom calendar fetched successfully.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarResponse" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/calendars/{calendar_identifier}/update": { "post": { "operationId": "updateCalendar", "description": "\n Version: 10.12.0.cl or later\n\nUpdates the properties of a [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal).\n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required.\n\n#### Usage guidelines\n\nYou can update the properties of a calendar using one of the following methods:\n* `FROM_INPUT_PARAMS` to update the calendar properties with the values defined in the API request.\n* `FROM_EXISTING_TABLE` Creates a calendar from the parameters defined in the API request.\n\nTo update a custom calendar, specify the calendar ID as a path parameter in the request URL and the following parameters in the request body: \n\n* Connection ID and Table name\n* Database and schema name attributes:\n For most Cloud Data Warehouse (CDW) connectors, both `database_name` and `schema_name` attributes are required. \n However, the attribute requirements are conditional and vary based on the connector type and its metadata structure. For example, for connectors such as Teradata, MySQL, SingleSore, Amazon Aurora MySQL, Amazon RDS MySQL, Oracle, and GCP_MYSQL, the `schema_name` is required, whereas the `database_name` attribute is not.\n Similarly, connectors such as ClickHouse require you to specify the `database_name` and the schema specification in such cases is optional.\n\nThe API allows you to modify the calendar type, month offset value, start and end date, starting day of the week, and prefixes assigned to the year and quarter labels. \n\n#### Examples\n\nUpdate a custom calendar using an existing Table in ThoughtSpot:\n\n```\n{\n \"update_method\": \"FROM_EXISTING_TABLE\",\n \"table_reference\": {\n \"connection_identifier\": \"Connection1\",\n \"database_name\": \"db1\",\n \"table_name\": \"custom_calendar_2025\",\n \"schame_name\": \"schemaVar\"\n }\n}\n```\n\nUpdate a custom calendar with the attributes defined in the API request:\n\n```\n{\n \"update_method\": \"FROM_INPUT_PARAMS\",\n \"table_reference\": {\n \"connection_identifier\": \"Connection1\",\n \"database_name\": \"db1\",\n \"table_name\": \"custom_calendar_2025\",\n \"schame_name\": \"schemaVar\"\n },\n \"month_offset\": \"August\",\n \"start_day_of_week\": \"Monday\",\n \"start_date\": \"08/01/2025\",\n \"end_date\": \"07/31/2026\"\n}\n```\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Custom Calendars", "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCalendarRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "calendar_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique Id or name of the calendar." } ], "responses": { "204": { "description": "Custom calendar updated successfully." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/answer/data": { "post": { "operationId": "fetchAnswerData", "description": "\n Version: 9.0.0.cl or later\n\nFetches data from a saved Answer.\n\nRequires at least view access to the saved Answer. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CAN_DOWNLOAD_DETAILED_DATA` (**Can download detailed data**) privilege is also required.\n\nThe `record_size` attribute determines the number of records to retrieve in an API call. For more information about pagination, record size, and maximum row limit, see [Pagination and record size settings](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_pagination_settings_for_data_and_report_apis).\n\n\n\n#### Endpoint URL\n", "tags": [ "Data", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchAnswerDataRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Fetching data of specified metadata object is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerDataResponse" }, "examples": { "example_1": { "summary": "data_format COMPACT (default): each row is an array of values in column_names order", "value": { "metadata_id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d", "metadata_name": "Revenue by Region", "contents": [ { "available_data_row_count": 2, "column_names": [ "Region", "Total Revenue" ], "data_rows": [ [ "East", 125000 ], [ "West", 98000 ] ], "record_offset": 0, "record_size": 10, "returned_data_row_count": 2, "sampling_ratio": 1 } ] } }, "example_2": { "summary": "data_format FULL: each row is an object keyed by column name", "value": { "metadata_id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d", "metadata_name": "Revenue by Region", "contents": [ { "available_data_row_count": 2, "column_names": [ "Region", "Total Revenue" ], "data_rows": [ { "Region": "East", "Total Revenue": 125000 }, { "Region": "West", "Total Revenue": 98000 } ], "record_offset": 0, "record_size": 10, "returned_data_row_count": 2, "sampling_ratio": 1 } ] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/liveboard/data": { "post": { "operationId": "fetchLiveboardData", "description": "\n Version: 9.0.0.cl or later\n\nGets data from a Liveboard object and its visualization. \n\nRequires at least view access to the Liveboard. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CAN_DOWNLOAD_DETAILED_DATA` (**Can download detailed data**) privilege is also required.\n\n#### Usage guidelines\n\nIn the request body, specify the GUID or name of the Liveboard. To get data for specific visualizations, add the GUIDs or names of the visualizations in the API request.\n\nTo include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes. If the new Liveboard experience mode, the transient content includes ad hoc changes to visualizations such as sorting, toggling of legends, and data drill down.\n\nFor more information, and see [Liveboard data API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_fetch_liveboard_data_api).\n\n\n\n#### Endpoint URL\n", "tags": [ "Data", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchLiveboardDataRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Fetching data of specified metadata object is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveboardDataResponse" }, "examples": { "example_1": { "summary": "data_format COMPACT (default): each row is an array of values in column_names order", "value": { "metadata_id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e", "metadata_name": "Sales Overview", "contents": [ { "available_data_row_count": 2, "column_names": [ "Region", "Total Revenue" ], "data_rows": [ [ "East", 125000 ], [ "West", 98000 ] ], "record_offset": 0, "record_size": 10, "returned_data_row_count": 2, "sampling_ratio": 1, "visualization_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f", "visualization_name": "Revenue by Region" } ] } }, "example_2": { "summary": "data_format FULL: each row is an object keyed by column name", "value": { "metadata_id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e", "metadata_name": "Sales Overview", "contents": [ { "available_data_row_count": 2, "column_names": [ "Region", "Total Revenue" ], "data_rows": [ { "Region": "East", "Total Revenue": 125000 }, { "Region": "West", "Total Revenue": 98000 } ], "record_offset": 0, "record_size": 10, "returned_data_row_count": 2, "sampling_ratio": 1, "visualization_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f", "visualization_name": "Revenue by Region" } ] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/searchdata": { "post": { "operationId": "searchData", "description": "\n Version: 9.0.0.cl or later\n\nGenerates an Answer from a given data source.\n\nRequires at least view access to the data source object (Worksheet or View). If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CAN_DOWNLOAD_DETAILED_DATA` (**Can download detailed data**) privilege is also required.\n\n#### Usage guidelines\n\nTo search data, specify the data source GUID in `logical_table_identifier`. The data source can be a Worksheet, View, Table, or SQL view.\n\nPass search tokens in the `query_string` attribute in the API request as shown in the following example:\n\n```\n{\n \"query_string\": \"[sales] by [store]\",\n \"logical_table_identifier\": \"cd252e5c-b552-49a8-821d-3eadaa049cca\",\n}\n```\n\nFor more information about the `query_string` format and data source attribute, see [Search data API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_search_data_api). \n\nThe `record_size` attribute determines the number of records to retrieve in an API call. For more information about pagination, record size, and maximum row limit, see [Pagination and record size settings](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_pagination_settings_for_data_and_report_api). \n\n\n\n#### Endpoint URL\n", "tags": [ "Data", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchDataRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Fetching data of specified metadata object is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchDataResponse" }, "examples": { "example_1": { "summary": "data_format COMPACT (default): each row is an array of values in column_names order", "value": { "contents": [ { "available_data_row_count": 2, "column_names": [ "Region", "Total Revenue" ], "data_rows": [ [ "East", 125000 ], [ "West", 98000 ] ], "record_offset": 0, "record_size": 10, "returned_data_row_count": 2, "sampling_ratio": 1 } ] } }, "example_2": { "summary": "data_format FULL: each row is an object keyed by column name", "value": { "contents": [ { "available_data_row_count": 2, "column_names": [ "Region", "Total Revenue" ], "data_rows": [ { "Region": "East", "Total Revenue": 125000 }, { "Region": "West", "Total Revenue": 98000 } ], "record_offset": 0, "record_size": 10, "returned_data_row_count": 2, "sampling_ratio": 1 } ] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/dbt/dbt-connection": { "post": { "operationId": "dbtConnection", "description": "\n Version: 9.9.0.cl or later\n\nCreates a DBT connection object in ThoughtSpot.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n\n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n#### About create DBT connection\nDBT connection in ThoughtSpot is used by the user to define DBT credentials for cloud . The API needs embrace connection, embrace database name, DBT url, import type, DBT account identifier, DBT project identifier, DBT access token and environment details (or) embrace connection, embrace database name, import type, file_content to create a connection object. To know more about DBT, see ThoughtSpot Product Documentation.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "DBT", "9.9.0.cl" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "connection_name": { "description": "Name of the connection.", "type": "string" }, "database_name": { "description": "Name of the Database.", "type": "string" }, "import_type": { "description": "Mention type of Import", "default": "DBT_CLOUD", "type": "string", "enum": [ "DBT_CLOUD", "ZIP_FILE" ] }, "access_token": { "description": "Access token is mandatory when Import_Type is DBT_CLOUD.", "type": "string" }, "dbt_url": { "description": "DBT URL is mandatory when Import_Type is DBT_CLOUD.", "type": "string" }, "account_id": { "description": "Account ID is mandatory when Import_Type is DBT_CLOUD", "type": "string" }, "project_id": { "description": "Project ID is mandatory when Import_Type is DBT_CLOUD", "type": "string" }, "dbt_env_id": { "description": "DBT Environment ID\"", "type": "string" }, "project_name": { "description": "Name of the project", "type": "string" }, "file_content": { "description": "Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is Mandatory when Import Type is 'ZIP_FILE'", "type": "string", "format": "binary" } }, "required": [ "connection_name", "database_name" ] } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Succesfully created DBT Connection.", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "example": { "summary": "DBT connection created for a Snowflake connection", "value": { "dbt_connection_identifier": "d3e4f5a6-0003-4b7c-8d9e-0f1a2b3c4d5e", "connection_id": "5e6b4a3c-2f1d-4e8a-9b7c-0d1e2f3a4b5c" } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/dbt/generate-sync-tml": { "post": { "operationId": "dbtGenerateSyncTml", "description": "\n Version: 9.9.0.cl or later\n\nResynchronize the existing list of models, tables, worksheet tml’s and import them to Thoughtspot based on the DBT connection object.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege, along with an existing DBT connection.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following data control privileges may be required:\n\n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n\n\n\n#### Endpoint URL\n", "tags": [ "DBT", "9.9.0.cl" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "dbt_connection_identifier": { "description": "Unique ID of the DBT connection.", "type": "string" }, "file_content": { "description": "Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is mandatory if the connection was created with import_type ‘ZIP_FILE’", "type": "string", "format": "binary" }, "include_semantic_report": { "description": "If true, includes a `semantic_report` per model showing which components were imported or skipped. Each component includes its name, type (such as dimension, measure, or metric), import status, SQL expression, and the corresponding generated ThoughtSpot formula. Note: supported only for Snowflake and Databricks connections.", "type": "boolean", "nullable": true } }, "required": [ "dbt_connection_identifier" ] } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Sync Table and Worksheet TML's are successfully generated.", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "example": { "summary": "Regenerated TML after syncing a DBT model", "value": { "worksheet_tmls": { "Marketing Model": "guid: b7c8d9e0-0007-4f1a-8b2c-4d5e6f7a8b9c\nworksheet:\n name: Marketing Model\n" }, "table_tmls": [ { "guid": "c8d9e0f1-0008-4a2b-9c3d-5e6f7a8b9c0d", "name": "CAMPAIGNS" }, { "guid": "d9e0f1a2-0009-4b3c-8d4e-6f7a8b9c0d1e", "name": "LEADS" } ], "failed_table_tmls": [], "semantic_report": [ { "model_name": "Marketing Model", "model_id": "b7c8d9e0-0007-4f1a-8b2c-4d5e6f7a8b9c", "semantic_components": [ { "name": "Campaign Spend", "semantic_type": "MEASURE", "import_status": "IMPORTED", "sql_expression": "sum(campaigns.spend)", "translated_formula": "sum ( [spend] )" }, { "name": "Cost Per Lead", "semantic_type": "METRIC", "import_status": "IMPORTED", "sql_expression": "sum(campaigns.spend) / nullif(count(leads.lead_id), 0)", "translated_formula": "sum ( [spend] ) / safe_divide ( count ( [lead_id] ) )" }, { "name": "Channel", "semantic_type": "DIMENSION", "import_status": "SKIPPED", "sql_expression": "campaigns.channel_group", "translated_formula": "" } ] } ] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/dbt/generate-tml": { "post": { "operationId": "dbtGenerateTml", "description": "\n Version: 9.9.0.cl or later\n\nGenerate required table and worksheet and import them.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege, along with an existing DBT connection.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following data control privileges may be required:\n\n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n#### About generate TML\nModels and Worksheets to be imported can be selected by the user as part of the API.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "DBT", "9.9.0.cl" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "dbt_connection_identifier": { "description": "Unique ID of the DBT connection.", "type": "string" }, "model_tables": { "description": "List of Models and their respective Tables\nExample: '[{\"model_name\": \"model_name\", \"model_path\": \"model_path\", \"tables\": [\"table_name\"]}]'", "type": "string", "format": "json" }, "import_worksheets": { "description": "Mention the worksheet tmls to import", "type": "string", "enum": [ "ALL", "NONE", "SELECTED" ] }, "worksheets": { "description": "List of worksheets is mandatory when import_Worksheets is type SELECTED\nExample: [\"worksheet_name\"]", "type": "string", "format": "json" }, "file_content": { "description": "Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is mandatory if the connection was created with import_type ‘ZIP_FILE’", "type": "string", "format": "binary" }, "include_semantic_report": { "description": "If true, includes a `semantic_report` per model showing which components were imported or skipped. Each component includes its name, type (such as dimension, measure, or metric), import status, SQL expression, and the corresponding generated ThoughtSpot formula. Note: supported only for Snowflake and Databricks connections.", "type": "boolean", "nullable": true } }, "required": [ "dbt_connection_identifier", "model_tables", "import_worksheets" ] } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Required Table and Worksheet TML's are successfully generated.", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "example": { "summary": "Generated TML for a DBT model, including the semantic report", "value": { "worksheet_tmls": { "Sales Model": "guid: e4f5a6b7-0004-4c8d-9e0f-1a2b3c4d5e6f\nworksheet:\n name: Sales Model\n" }, "table_tmls": [ { "guid": "f5a6b7c8-0005-4d9e-8f0a-2b3c4d5e6f7a", "name": "ORDERS" }, { "guid": "a6b7c8d9-0006-4e0f-9a1b-3c4d5e6f7a8b", "name": "CUSTOMERS" } ], "failed_table_tmls": [ "RETURNS" ], "semantic_report": [ { "model_name": "Sales Model", "model_id": "e4f5a6b7-0004-4c8d-9e0f-1a2b3c4d5e6f", "semantic_components": [ { "name": "Total Sales", "semantic_type": "MEASURE", "import_status": "IMPORTED", "sql_expression": "sum(orders.sales)", "translated_formula": "sum ( [sales] )" }, { "name": "Region", "semantic_type": "DIMENSION", "import_status": "SKIPPED", "sql_expression": "customers.region", "translated_formula": "" } ] } ] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/dbt/search": { "post": { "operationId": "dbtSearch", "description": "\n Version: 9.9.0.cl or later\n\nGets a list of DBT connection objects by user and organization, available on the ThoughtSpot system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n\n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n#### About search DBT connection\nTo get details of a specific DBT connection identifier, database connection identifier, database connection name, database name, project name, project identifier, environment identifier , import type and author.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "DBT", "9.9.0.cl" ], "parameters": [], "responses": { "200": { "description": "Retrieved list of DBT connections successfully.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DbtSearchResponse" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/dbt/{dbt_connection_identifier}/delete": { "post": { "operationId": "deleteDbtConnection", "description": "\n Version: 9.9.0.cl or later\n\nRemoves the specified DBT connection object from the ThoughtSpot system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DATAMANAGEMENT` (**Can manage data ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n\n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n\n\n\n#### Endpoint URL\n", "tags": [ "DBT", "9.9.0.cl" ], "parameters": [ { "in": "path", "name": "dbt_connection_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID of the DBT Connection." } ], "responses": { "204": { "description": "DBT Connection successfully deleted." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/dbt/update-dbt-connection": { "post": { "operationId": "updateDbtConnection", "description": "\n Version: 9.9.0.cl or later\n\nUpdates a DBT connection object.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data ThoughtSpot**) privilege, along with an existing DBT connection.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following data control privileges may be required:\n\n- `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**)\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n#### About update DBT connection\nYou can modify DBT connection object properties such as embrace connection name, embrace database name, import type, account identifier, access token, project identifier and environment (or) embrace connection, embrace database name, import type, file_content settings.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "DBT", "9.9.0.cl" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "dbt_connection_identifier": { "description": "Unique ID of the DBT Connection.", "type": "string" }, "connection_name": { "description": "Name of the connection.", "type": "string" }, "database_name": { "description": "Name of the Database.", "type": "string" }, "import_type": { "description": "Mention type of Import", "default": "DBT_CLOUD", "type": "string", "enum": [ "DBT_CLOUD", "ZIP_FILE" ] }, "access_token": { "description": "Access token is mandatory when Import_Type is DBT_CLOUD.", "type": "string" }, "dbt_url": { "description": "DBT URL is mandatory when Import_Type is DBT_CLOUD.", "type": "string" }, "account_id": { "description": "Account ID is mandatory when Import_Type is DBT_CLOUD", "type": "string" }, "project_id": { "description": "Project ID is mandatory when Import_Type is DBT_CLOUD", "type": "string" }, "dbt_env_id": { "description": "DBT Environment ID\"", "type": "string" }, "project_name": { "description": "Name of the project", "type": "string" }, "file_content": { "description": "Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is Mandatory when Import Type is 'ZIP_FILE'", "type": "string", "format": "binary" } }, "required": [ "dbt_connection_identifier" ] } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "DBT Connection successfully updated.", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/customization/email": { "post": { "operationId": "createEmailCustomization", "description": "\nBeta Version: 10.10.0.cl or later\n\nCreates a customization configuration for the notification email.\n\n#### Pre-requisites\n\nRequires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.\n\n#### Usage guidelines\n\nTo create a custom configuration pass these parameters in your API request:\n\n- A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration:\n\n```\n{\n {\n \"cta_button_bg_color\": \"#444DEA\",\n \"cta_text_font_color\": \"#FFFFFF\",\n \"primary_bg_color\": \"#D3DEF0\",\n \"logo_url\": \"https://storage.pardot.com/710713/1642089901EbkRibJq/TS_fullworkmark_darkmode.png\",\n \t \"font_family\": \"\",\n \"product_name\": \"ThoughtSpot\",\n \"footer_address\": \"444 Castro St, Suite 1000 Mountain View, CA 94041\",\n\t \"footer_phone\": \"(800) 508-7008\",\n \"replacement_value_for_liveboard\": \"Dashboard\",\n \"replacement_value_for_answer\": \"Chart\",\n \"replacement_value_for_spot_iq\": \"AI Insights\",\n \t \"hide_footer_phone\": false,\n \"hide_footer_address\": false,\n \"hide_product_name\": false,\n \"hide_manage_notification\": false,\n \"hide_mobile_app_nudge\": false,\n \"hide_privacy_policy\": false,\n \"hide_ts_vocabulary_definitions\": false,\n \"hide_error_message\": false,\n \"hide_unsubscribe_link\": false,\n \"hide_notification_status\": false,\n \"hide_modify_alert\": false,\n \"company_website_url\": \"https://your-website.com/\",\n \"company_privacy_policy_url\" : \"https://link-to-privacy-policy.com/\",\n \"contact_support_url\": \"https://link-to-contact-support.com/\",\n \"hide_contact_support_url\": false,\n\t \"hide_logo_url\" : false\n }\n}\n```\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Email Customization", "10.10.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEmailCustomizationRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEmailCustomizationResponse" }, "examples": { "example": { "value": { "tenant_id": "", "org": { "name": "Primary", "id": 0 }, "name": "", "template_properties": { "cta_button_bg_color": "#444dea", "cta_text_font_color": "#ffffff", "primary_bg_color": "#d3def0", "home_url": "https://www.example.com", "logo_url": "https://www.example.com/logo.png", "font_family": "Arial, sans-serif", "product_name": "", "footer_address": "", "footer_phone": "", "replacement_value_for_liveboard": "Dashboard", "replacement_value_for_answer": "Chart", "replacement_value_for_spot_iq": "AI Insights", "hide_footer_address": false, "hide_footer_phone": false, "hide_manage_notification": false, "hide_mobile_app_nudge": false, "hide_privacy_policy": false, "hide_product_name": false, "hide_ts_vocabulary_definitions": false, "hide_notification_status": false, "hide_error_message": false, "hide_unsubscribe_link": false, "hide_modify_alert": false, "company_privacy_policy_url": "https://www.example.com/privacy", "company_website_url": "https://www.example.com", "contact_support_url": "https://www.example.com/support", "hide_contact_support_url": false, "hide_logo_url": false } } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/customization/email/{template_identifier}/delete": { "post": { "operationId": "deleteEmailCustomization", "description": "\nBeta Version: 10.10.0.cl or later\n\nDeletes the configuration for the email customization.\n\n#### Pre-requisites\n\nRequires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.\n\n#### Usage guidelines\n\n- Call the search API endpoint to get the `template_identifier` from the response.\n- Use that `template_identifier` as a parameter in this API request.\n\n\n\n\n#### Endpoint URL\n", "deprecated": true, "tags": [ "Email Customization", "10.10.0.cl" ], "parameters": [ { "in": "path", "name": "template_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the email customization." } ], "responses": { "204": { "description": "Email Customization configuration successfully deleted." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/customization/email/delete": { "post": { "operationId": "deleteOrgEmailCustomization", "description": "\nBeta Version: 10.12.0.cl or later\n\nDeletes the configuration for the email customization.\n\n#### Pre-requisites\n\nRequires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.\n\n#### Usage guidelines\n\n- Call the search API endpoint to get the `org_identifier` from the response.\n- Use that `org_identifier` as a parameter in this API request.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Email Customization", "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrgEmailCustomizationRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Email Customization configuration successfully deleted." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/customization/email/search": { "post": { "operationId": "searchEmailCustomization", "description": "\nBeta Version: 10.10.0.cl or later\n\nSearch the email customization configuration if any set for the ThoughtSpot system.\n\n#### Pre-requisites\n\nRequires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Email Customization", "10.10.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchEmailCustomizationRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateEmailCustomizationResponse" } }, "examples": { "example": { "value": [ { "tenant_id": "", "org": { "name": "Primary", "id": 0 }, "name": "", "template_properties": { "cta_button_bg_color": "#444dea", "cta_text_font_color": "#ffffff", "primary_bg_color": "#d3def0", "home_url": "https://www.example.com", "logo_url": "https://www.example.com/logo.png", "font_family": "Arial, sans-serif", "product_name": "", "footer_address": "", "footer_phone": "", "replacement_value_for_liveboard": "Dashboard", "replacement_value_for_answer": "Chart", "replacement_value_for_spot_iq": "AI Insights", "hide_footer_address": false, "hide_footer_phone": false, "hide_manage_notification": false, "hide_mobile_app_nudge": false, "hide_privacy_policy": false, "hide_product_name": false, "hide_ts_vocabulary_definitions": false, "hide_notification_status": false, "hide_error_message": false, "hide_unsubscribe_link": false, "hide_modify_alert": false, "company_privacy_policy_url": "https://www.example.com/privacy", "company_website_url": "https://www.example.com", "contact_support_url": "https://www.example.com/support", "hide_contact_support_url": false, "hide_logo_url": false } }, { "tenant_id": "", "org": { "name": "", "id": 1234567890 }, "name": "", "template_properties": { "product_name": "", "hide_mobile_app_nudge": true } } ] } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/customization/email/update": { "post": { "operationId": "updateEmailCustomization", "description": "\nBeta Version: 10.12.0.cl or later\n\nUpdates a customization configuration for the notification email.\n\n#### Pre-requisites\n\nRequires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.\n\n#### Usage guidelines\n\nTo update a custom configuration pass these parameters in your API request:\n\n- A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration:\n\n```\n{\n {\n \"cta_button_bg_color\": \"#444DEA\",\n \t\"cta_text_font_color\": \"#FFFFFF\",\n \t\"primary_bg_color\": \"#D3DEF0\",\n \"logo_url\": \"https://storage.pardot.com/710713/1642089901EbkRibJq/TS_fullworkmark_darkmode.png\",\n \t \"font_family\": \"\",\n \t\"product_name\": \"ThoughtSpot\",\n \t\"footer_address\": \"444 Castro St, Suite 1000 Mountain View, CA 94041\",\n\t \"footer_phone\": \"(800) 508-7008\",\n \"replacement_value_for_liveboard\": \"Dashboard\",\n \t\"replacement_value_for_answer\": \"Chart\",\n \t\"replacement_value_for_spot_iq\": \"AI Insights\",\n \t \"hide_footer_phone\": false,\n \"hide_footer_address\": false,\n \"hide_product_name\": false,\n \t\"hide_manage_notification\": false,\n \t\"hide_mobile_app_nudge\": false,\n \t\"hide_privacy_policy\": false,\n \t\"hide_ts_vocabulary_definitions\": false,\n \t\"hide_error_message\": false,\n \t\"hide_unsubscribe_link\": false,\n \"hide_notification_status\": false,\n \t\"hide_modify_alert\": false,\n \t\"company_website_url\": \"https://your-website.com/\",\n \t\"company_privacy_policy_url\" : \"https://link-to-privacy-policy.com/\",\n \"contact_support_url\": \"https://link-to-contact-support.com/\",\n \"hide_contact_support_url\": false,\n\t \"hide_logo_url\" : false\n }\n}\n```\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Email Customization", "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEmailCustomizationRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Email Customization configuration successfully updated." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/customization/email/validate": { "post": { "operationId": "validateEmailCustomization", "description": "\nBeta Version: 10.10.0.cl or later\n\nValidates the email customization configuration if any set for the ThoughtSpot system.\n\n#### Pre-requisites\n\nRequires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.\n\n**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Email Customization", "10.10.0.cl" ], "parameters": [], "responses": { "204": { "description": "Triggered test email for customization configuration" }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/configurations/features/search": { "post": { "operationId": "searchFeatures", "description": "\n Version: 26.10.0.cl or later\n\nVersion: 26.10.0.cl or later\n\nReturns the feature configurations available on the ThoughtSpot system, grouped by feature group.\n\n#### Pre-requisites\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege is required.\n\n#### Usage guidelines\n\nTo retrieve feature configurations, pass these parameters in your API request:\n\n- `scope` — Determines the administrative view. Use `CLUSTER` for the cluster-admin view (returns the Orgs assigned to each feature); use `ORG` for the org-admin view (returns the current value of each feature for a single Org).\n- `org_identifier` — Numeric ID of the Org. Required when `scope` is `ORG`; ignored when `scope` is `CLUSTER`.\n- `category` — Availability category of the features to return. `GENERAL_ACCESS` returns generally available features; `EARLY_ACCESS` returns features still in early access. Defaults to `GENERAL_ACCESS`.\n\nThe response fields populated depend on the requested scope. In the cluster-admin view (`scope=CLUSTER`), each feature includes `assigned_orgs`, `is_org_aware`, and (for non-org-aware features) `feature_value`. In the org-admin view (`scope=ORG`), each feature includes `element_type`, `element_config`, and `element_value`.\n\nThe following example retrieves the general-access features for the cluster-admin view:\n\n```\n{\n \"scope\": \"CLUSTER\",\n \"category\": \"GENERAL_ACCESS\"\n}\n```\n\nFor the org-admin view, set `scope` to `ORG` and pass the `org_identifier` of the Org to scope the search to (`org_identifier` is required when `scope` is `ORG`; omitting it returns a 400 error):\n\n```\n{\n \"scope\": \"ORG\",\n \"org_identifier\": 1,\n \"category\": \"GENERAL_ACCESS\"\n}\n```\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Feature Management", "26.10.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchFeaturesRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Feature groups returned.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureGroup" } }, "examples": { "example_1": { "description": "Cluster-admin view (scope=CLUSTER) — org-aware feature with assignments", "value": [ { "feature_group": "search", "docs_url": null, "features": [ { "feature_id": "orion.embraceConfig.doIndexing", "feature_name": "index_columns", "assigned_orgs": [ { "org_id": 0, "org_name": "Primary" } ], "is_org_aware": true, "feature_value": null, "docs_url": null } ] } ] }, "example_2": { "description": "Org-admin view (scope=ORG) — element type, config, and current value for the org", "value": [ { "feature_group": "search", "docs_url": null, "features": [ { "feature_id": "orion.embraceConfig.doIndexing", "feature_name": "index_columns", "element_type": "toggle", "element_config": { "label": "Index columns" }, "element_value": "true", "docs_url": null } ] } ] }, "example_3": { "description": "Empty result — no features match the requested category", "value": [] } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing_org_identifier": { "summary": "Bad Request — org_identifier is required when scope is ORG", "value": { "error": { "message": { "code": 10000, "incident_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "trace_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "debug": "org_identifier is required when scope=ORG." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient privileges.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden — ADMINISTRATION privilege required", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "trace_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "debug": "Insufficient privileges." } } } } } } } }, "404": { "description": "Feature management not enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/configurations/features/assignments/update": { "post": { "operationId": "updateFeatureAssignments", "description": "\n Version: 26.10.0.cl or later\n\nVersion: 26.10.0.cl or later\n\nUpdates the Org assignments for a feature. Available to cluster admins only.\n\n#### Pre-requisites\n\nRequires the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege in the cluster-admin (All-Org / default-org) context. This endpoint manages Org assignments across the cluster, so it must be called by a cluster admin; org-scoped admins cannot call it.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege is required.\n\n#### Usage guidelines\n\nTo update the Org assignments for a feature, pass these parameters in your API request:\n\n- `feature_identifier` — User-friendly feature name (`feature_name`) or the underlying feature ID (`feature_id`) of the feature to update.\n- `org_identifiers` — Numeric IDs of the Orgs to assign. Send an empty array with `operation` set to `REPLACE` to clear all Org assignments for this feature.\n- `operation` — Type of update to apply. `ADD` assigns the given Orgs in addition to the existing ones; `REMOVE` unassigns the given Orgs; `REPLACE` sets the assignment to exactly the given Orgs. Defaults to `REPLACE`.\n\nThe following example assigns Orgs `1` and `2` to a feature, in addition to any Orgs already assigned:\n\n```\n{\n \"feature_identifier\": \"index_columns\",\n \"org_identifiers\": [1, 2],\n \"operation\": \"ADD\"\n}\n```\n\nClear all Org assignments for a feature by sending an empty array with `operation` set to `REPLACE` (this is the only way to unassign every Org at once):\n\n```\n{\n \"feature_identifier\": \"index_columns\",\n \"org_identifiers\": [],\n \"operation\": \"REPLACE\"\n}\n```\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Feature Management", "26.10.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFeatureAssignmentsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Assignments updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureAssignmentResponse" }, "examples": { "example_1": { "description": "Assign Orgs 1 and 2 to the feature (operation ADD)", "value": { "feature_id": "orion.embraceConfig.doIndexing", "feature_name": "index_columns", "assigned_orgs": [ { "org_id": 1, "org_name": "Acme" }, { "org_id": 2, "org_name": "Beta" } ] } }, "example_2": { "description": "Clear all Org assignments (operation REPLACE with an empty org_identifiers array); assigned_orgs comes back empty", "value": { "feature_id": "orion.embraceConfig.doIndexing", "feature_name": "index_columns", "assigned_orgs": [] } } } } } }, "400": { "description": "Invalid request parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing_org_identifiers": { "summary": "Bad Request — org_identifiers is required", "value": { "error": { "message": { "code": 10000, "incident_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "trace_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "debug": "org_identifiers is required." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient privileges.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden — ADMINISTRATION privilege required", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "trace_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "debug": "Insufficient privileges." } } } } } } } }, "404": { "description": "Feature not found or feature management not enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "feature_not_found": { "summary": "Not Found — feature_identifier does not match any known feature", "value": { "error": { "message": { "code": 10000, "incident_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "trace_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "debug": "Feature 'orion.__does_not_exist__' not found in config." } } } } } } } }, "500": { "description": "Unexpected error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/configurations/features/values/update": { "post": { "operationId": "updateFeatureValue", "description": "\n Version: 26.10.0.cl or later\n\nVersion: 26.10.0.cl or later\n\nSets the value of a feature at the cluster or Org scope.\n\n#### Pre-requisites\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege is required.\n\n#### Usage guidelines\n\nTo set a feature value, pass these parameters in your API request:\n\n- `scope` — Determines the scope at which the value is set. Use `CLUSTER` to set the cluster-level value; use `ORG` to set a per-Org value override.\n- `org_identifier` — Numeric ID of the Org for which to set the value. Required when `scope` is `ORG`; ignored when `scope` is `CLUSTER`.\n- `feature_identifier` — User-friendly feature name (`feature_name`) or the underlying feature ID (`feature_id`) of the feature whose value should be set.\n- `feature_value` — New value to set for the feature.\n- `reset_org_overrides` — Applicable only when `scope` is `CLUSTER`. When `true`, any existing per-Org value overrides for this feature are also removed so that all Orgs inherit the new cluster-level value. Required when `scope` is `CLUSTER` for an org-aware feature. Must be omitted when `scope` is `ORG`; passing it at `ORG` scope returns a 400 error.\n\nThe following example sets a per-Org value override for Org `1`:\n\n```\n{\n \"scope\": \"ORG\",\n \"org_identifier\": 1,\n \"feature_identifier\": \"index_columns\",\n \"feature_value\": \"true\"\n}\n```\n\nSet the cluster-level value and clear all per-Org overrides so every Org inherits the new value (CLUSTER scope). `reset_org_overrides: true` is destructive — it strips existing per-Org overrides cluster-wide:\n\n```\n{\n \"scope\": \"CLUSTER\",\n \"feature_identifier\": \"index_columns\",\n \"feature_value\": \"true\",\n \"reset_org_overrides\": true\n}\n```\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Feature Management", "26.10.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFeatureValueRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Value updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeatureValueResponse" }, "examples": { "example_1": { "description": "Set a per-Org value override (scope=ORG)", "value": { "feature_id": "orion.embraceConfig.doIndexing", "feature_name": "index_columns", "feature_value": "true" } }, "example_2": { "description": "Set the cluster-level value and clear per-Org overrides (scope=CLUSTER, reset_org_overrides=true)", "value": { "feature_id": "orion.embraceConfig.doIndexing", "feature_name": "index_columns", "feature_value": "true" } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_reset_org_overrides": { "summary": "Bad Request — reset_org_overrides is not allowed when scope is ORG", "value": { "error": { "message": { "code": 10000, "incident_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "trace_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "debug": "reset_org_overrides is only valid for scope=CLUSTER." } } } }, "missing_org_identifier": { "summary": "Bad Request — org_identifier is required when scope is ORG", "value": { "error": { "message": { "code": 10000, "incident_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "trace_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "debug": "org_identifier is required when scope=ORG." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Insufficient privileges or org not assigned to feature.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden — ADMINISTRATION privilege required", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "trace_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "debug": "Insufficient privileges." } } } } } } } }, "404": { "description": "Feature not found or feature management not enabled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "feature_not_found": { "summary": "Not Found — feature_identifier does not match any known feature", "value": { "error": { "message": { "code": 10000, "incident_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "trace_id_guid": "0d2f9f6e-0000-0000-0000-000000000000", "debug": "Feature 'orion.__does_not_exist__' not found in config." } } } } } } } }, "500": { "description": "Unexpected error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/groups/create": { "post": { "operationId": "createUserGroup", "description": "\n Version: 9.0.0.cl or later\n\nCreates a group object in ThoughtSpot.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required.\n\n#### About groups\nGroups in ThoughtSpot are used by the administrators to define privileges and organize users based on their roles and access requirements. To know more about groups and privileges, see [ThoughtSpot Product Documentation](https://docs.thoughtspot.com/cloud/latest/groups-privileges).\n\n#### Supported operations\n\nThe API endpoint lets you perform the following operations:\n\n* Assign privileges\n* Add users\n* Define sharing visibility\n* Add sub-groups\n* Assign a default Liveboard\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Groups", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserGroupRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "User group successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupResponse" }, "examples": { "example": { "value": { "id": "7b8c9d0e-1f2a-4b3c-8d4e-5f6a7b8c9d0e", "obj_id": "7b8c9d0e-1f2a-4b3c-8d4e-5f6a7b8c9d0e", "name": "", "display_name": "", "description": "Group created for the sales analysts.", "visibility": "SHARABLE", "type": "LOCAL_GROUP", "parent_type": "GROUP", "content": { "schemaVersion": "3.1.0" }, "privileges": [ "DATADOWNLOADING", "USERDATAUPLOADING" ], "complete_detail": true, "deleted": false, "deprecated": false, "external": false, "hidden": false, "system_group": false, "generation_number": 1, "index": 0, "index_version": 1, "metadata_version": 1, "creation_time_in_millis": 1760198400000, "modification_time_in_millis": 1760198400000, "author_id": "8c9d0e1f-2a3b-4c4d-8e5f-6a7b8c9d0e1f", "modifier_id": "8c9d0e1f-2a3b-4c4d-8e5f-6a7b8c9d0e1f", "owner_id": "7b8c9d0e-1f2a-4b3c-8d4e-5f6a7b8c9d0e", "users": [], "sub_groups": [], "default_liveboards": [], "tags": [], "orgs": [ { "id": 0, "name": "Primary" } ], "roles": [] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/groups/{group_identifier}/delete": { "post": { "operationId": "deleteUserGroup", "description": "\n Version: 9.0.0.cl or later\n\nRemoves the specified group object from the ThoughtSpot system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Groups", "9.0.0.cl" ], "parameters": [ { "in": "path", "name": "group_identifier", "required": true, "schema": { "type": "string" }, "description": "GUID or name of the group." } ], "responses": { "204": { "description": "User group successfully deleted." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/groups/import": { "post": { "operationId": "importUserGroups", "description": "\n Version: 9.0.0.cl or later\n\nImports group objects from external databases into ThoughtSpot.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required.\n\nDuring the import operation:\n\n* If the specified group is not available in ThoughtSpot, it will be added to ThoughtSpot.\n* If `delete_unspecified_groups` is set to `true`, the groups not specified in the API request, excluding administrator and system user groups, are deleted.\n* If the specified groups are already available in ThoughtSpot, the object properties of these groups are modified and synchronized as per the input data in the API request.\n\nA successful API call returns the object that represents the changes made in the ThoughtSpot system.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Groups", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportUserGroupsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Import user groups operation successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportUserGroupsResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/groups/search": { "post": { "operationId": "searchUserGroups", "description": "\n Version: 9.0.0.cl or later\n\nGets a list of user group objects from the ThoughtSpot system.\n\nTo get details of a specific user group, specify the user group GUID or name. You can also filter the API response based on User ID, Org ID, Role ID, type of group, sharing visibility, privileges assigned to the group, and the Liveboard IDs assigned to the users in the group.\n\nAvailable to all users. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view all users properties.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required.\n\n**NOTE**: In addition to the GUID and name, `group_identifier` accepts a Custom object ID if one is configured for the group. The response also includes the `obj_id` field for each group that has one set.\n\n**Warning**: Do not set `record_size` to `-1`. On ThoughtSpot instances with a large number of objects or users, this can lead to slow responses, excessive logging, and out-of-memory failures. Specify an explicit `record_size` and iterate through pages programmatically.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Groups", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchUserGroupsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "User group search result.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupResponse" } }, "examples": { "example": { "value": [ { "id": "7b8c9d0e-1f2a-4b3c-8d4e-5f6a7b8c9d0e", "obj_id": "7b8c9d0e-1f2a-4b3c-8d4e-5f6a7b8c9d0e", "name": "", "display_name": "", "description": "Group created for the sales analysts.", "visibility": "SHARABLE", "type": "LOCAL_GROUP", "parent_type": "GROUP", "content": { "schemaVersion": "3.1.0" }, "privileges": [ "DATADOWNLOADING", "USERDATAUPLOADING" ], "complete_detail": true, "deleted": false, "deprecated": false, "external": false, "hidden": false, "system_group": false, "generation_number": 1, "index": 0, "index_version": 1, "metadata_version": 1, "creation_time_in_millis": 1760198400000, "modification_time_in_millis": 1760198400000, "author_id": "8c9d0e1f-2a3b-4c4d-8e5f-6a7b8c9d0e1f", "modifier_id": "8c9d0e1f-2a3b-4c4d-8e5f-6a7b8c9d0e1f", "owner_id": "7b8c9d0e-1f2a-4b3c-8d4e-5f6a7b8c9d0e", "users": [], "sub_groups": [], "default_liveboards": [], "tags": [], "orgs": [ { "id": 0, "name": "Primary" } ], "roles": [] }, { "id": "9d0e1f2a-3b4c-4d5e-8f6a-7b8c9d0e1f2a", "obj_id": "9d0e1f2a-3b4c-4d5e-8f6a-7b8c9d0e1f2a", "name": "", "display_name": "", "description": "Group with LDAP-sourced membership.", "visibility": "SHARABLE", "type": "LDAP_GROUP", "parent_type": "GROUP", "content": { "schemaVersion": "3.1.0" }, "privileges": [ "DATADOWNLOADING" ], "complete_detail": true, "deleted": false, "deprecated": false, "external": true, "hidden": false, "system_group": false, "generation_number": 1, "index": 0, "index_version": 1, "metadata_version": 1, "creation_time_in_millis": 1760198400000, "modification_time_in_millis": 1760198400000, "author_id": "8c9d0e1f-2a3b-4c4d-8e5f-6a7b8c9d0e1f", "modifier_id": "8c9d0e1f-2a3b-4c4d-8e5f-6a7b8c9d0e1f", "owner_id": "9d0e1f2a-3b4c-4d5e-8f6a-7b8c9d0e1f2a", "users": [], "sub_groups": [ { "id": "7b8c9d0e-1f2a-4b3c-8d4e-5f6a7b8c9d0e", "name": "" } ], "default_liveboards": [], "tags": [], "orgs": [ { "id": 0, "name": "Primary" } ], "roles": [] } ] } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/groups/{group_identifier}/update": { "post": { "operationId": "updateUserGroup", "description": "\n Version: 9.0.0.cl or later\n\nUpdates the properties of a group object in ThoughtSpot.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required.\n\n#### Supported operations\n\nThis API endpoint lets you perform the following operations in a single API request:\n\n* Edit [privileges](https://developers.thoughtspot.com/docs/?pageid=api-user-management#group-privileges)\n* Add or remove users\n* Change sharing visibility settings\n* Add or remove sub-groups\n* Assign a default Liveboard or update the existing settings\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Groups", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserGroupRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "group_identifier", "required": true, "schema": { "type": "string" }, "description": "GUID or name of the group." } ], "responses": { "204": { "description": "User group successfully updated." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/jobs/history/communication-channels/search": { "post": { "operationId": "searchChannelHistory", "description": "\n Version: 26.4.0.cl or later\n\nSearches delivery history for communication channels such as webhooks. Returns channel-level delivery status for each job execution record. Use this to monitor channel health and delivery success rates across events.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n**NOTE**: When `channel_type` is `WEBHOOK`, the following constraints apply:\n\n- `job_ids`, `channel_identifiers`, and `events` each accept at most one element.\n- When `job_ids` is provided, it is used as the sole lookup key and other filter fields are ignored.\n- When `job_ids` is not provided, `channel_identifiers` and `events` are both required, each containing exactly one element.\n- Records older than the configured retention period are not returned.\n- Use `start_epoch_time_in_millis` and/or `end_epoch_time_in_millis` to narrow results to a specific time window.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Jobs", "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchChannelHistoryRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Channel status logs retrieved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchChannelHistoryResponse" }, "examples": { "example_1": { "description": "Search webhook channel history by channel identifier and event", "value": { "jobs": [ { "id": "n.6170538a-a4d4-4712-91bf-39b353db2b72", "status": "SUCCESS", "creation_time_in_millis": 1771599720674, "event": { "type": "LIVEBOARD_SCHEDULE", "id": "2bb2ff83-b8d9-4d2b-8913-b2589bb6831b", "name": "schedule-identifier", "run_id": "90c4f1b0-08c9-4a6c-8e61-49cffd9f1550" }, "recipients": [ { "type": "USER", "id": "d211f619-8b72-45d3-92a7-69dde41159c7", "name": "admin-user", "email": "admin@example.com" } ], "detail": "", "try_count": 1 }, { "id": "n.5c5bbedb-c425-48c0-8b54-a17267b08e7c", "status": "SUCCESS", "creation_time_in_millis": 1771599600508, "event": { "type": "LIVEBOARD_SCHEDULE", "id": "2bb2ff83-b8d9-4d2b-8913-b2589bb6831b", "name": "schedule-identifier", "run_id": "b9834966-fe85-4fa9-8a10-9889c01d4826" }, "recipients": [ { "type": "USER", "id": "d211f619-8b72-45d3-92a7-69dde41159c7", "name": "admin-user", "email": "admin@example.com" } ], "detail": "", "try_count": 1 } ] } }, "example_2": { "description": "Search webhook channel history by job ID", "value": { "jobs": [ { "id": "n.5c5bbedb-c425-48c0-8b54-a17267b08e7c", "status": "SUCCESS", "creation_time_in_millis": 1771599600508, "event": { "type": "LIVEBOARD_SCHEDULE", "id": "2bb2ff83-b8d9-4d2b-8913-b2589bb6831b", "name": "schedule-identifier", "run_id": "b9834966-fe85-4fa9-8a10-9889c01d4826" }, "recipients": [ { "type": "USER", "id": "d211f619-8b72-45d3-92a7-69dde41159c7", "name": "admin-user", "email": "admin@example.com" } ], "detail": "", "try_count": 1 } ] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "channel_type must be specified. Currently only WEBHOOK is supported." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to retrieve channel delivery history." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Insufficient privileges to retrieve channel delivery history." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while retrieving channel delivery history." } } } } } } } } } } }, "/api/rest/2.0/logs/fetch": { "post": { "operationId": "fetchLogs", "description": "\n Version: 9.0.0.cl or later\n\nFetches security audit logs. \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the [Admin Control](https://developers.thoughtspot.com/docs/rbac#_admin_control) privileges are required.\n\n\n#### Usage guidelines\n\nBy default, the API retrieves logs for the last 24 hours. You can set a custom duration in EPOCH time. Make sure the log duration specified in your API request doesn’t exceed 24 hours. If you must fetch logs for a longer time range, modify the duration and make multiple sequential API requests.\n\nUpon successful execution, the API returns logs with the following information:\n* timestamp of the event\n* event ID\n* event type\n* name and GUID of the user\n* IP address of ThoughtSpot instance\n\nFor more information see [Audit logs Documentation](https://developers.thoughtspot.com/docs/audit-logs).\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Log", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchLogsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Log fetched successfully.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LogResponse" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/localizations/manual-translation/delete": { "post": { "operationId": "deleteManualTranslations", "description": "\nDelete manual translations.
Version: 26.7.0.cl or later\n\nDeletes all manual translations for the org.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**), `ORG_ADMINISTRATION` (**Can administer Org**), or `APPLICATION_ADMINISTRATION` (**Can administer application**) privilege.\n\n#### Usage guidelines\n\n- This deletes **all** translation entries for the targeted org. The operation cannot be undone.\n- Defaults to `ORG` scope if not specified.\n- Set `scope` to `CLUSTER` to delete translations uploaded in the All-Org context.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Manual Translation", "26.7.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteManualTranslationsRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Successfully deleted manual translations." }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/localizations/manual-translation/export": { "post": { "operationId": "exportManualTranslations", "description": "\nExport manual translations as a CSV file.
Version: 26.7.0.cl or later\n\nDownloads all manual translations for the org as a CSV file.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**), `ORG_ADMINISTRATION` (**Can administer Org**), or `APPLICATION_ADMINISTRATION` (**Can administer application**) privilege.\n\n#### Usage guidelines\n\n- The response is a CSV file with columns: `content`, `locale`, `translated-content`.\n- Defaults to `ORG` scope if not specified.\n- Set `scope` to `CLUSTER` to export translations from the All-Org context.\n- `scope` accepts only `ORG` (default) and `CLUSTER`, in uppercase. Any other value returns a `400` error.\n- Returns a `400` error if no translations exist for the targeted org or cluster scope.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Manual Translation", "26.7.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportManualTranslationsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "CSV file downloaded successfully.", "headers": { "Content-Disposition": { "description": "Indicates that the response is a file attachment.", "schema": { "type": "string", "example": "attachment; filename=\"manual-translation.csv\"" } } }, "content": { "application/octet-stream": {} } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "No translations file found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/localizations/manual-translation/locales/{locale}/export": { "post": { "operationId": "getManualTranslationBundle", "description": "\nGet translations bundle for a locale.
Version: 26.7.0.cl or later\n\nRetrieves all translations for a specific locale as a JSON map.\n\nAvailable to all authenticated users. No additional privileges are required.\n\n#### Usage guidelines\n\n- `locale` parameter must be a hyphenated locale code, in any case (for example, `fr-fr`, `de-de`, `JA-JP`).\n- Returns a JSON object with a `translations` map where each key is the original string and each value is the translated string.\n- If the org has no translations for the requested locale, the endpoint falls back to cluster-level translations.\n- Returns an empty `translations` map (not an error) if no entries exist at either level.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Manual Translation", "26.7.0.cl" ], "parameters": [ { "in": "path", "name": "locale", "required": true, "schema": { "type": "string" }, "description": "Locale code for which to retrieve translations. For example, `fr-fr`, `de-de`, `JA-JP`." } ], "responses": { "200": { "description": "Translation bundle retrieved successfully.", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "example": { "summary": "Manual translation bundle for a locale", "value": { "translations": { "liveboard.title.sales_overview": "Resumen de ventas", "column.label.total_sales": "Ventas totales" } } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "No translations found for the requested locale.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/localizations/manual-translation/import": { "post": { "operationId": "importManualTranslations", "description": "\nImport manual translations from a CSV file.
Version: 26.7.0.cl or later\n\nUploads a CSV file containing manual translations and upserts them into the database.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**), `ORG_ADMINISTRATION` (**Can administer Org**), or `APPLICATION_ADMINISTRATION` (**Can administer application**) privilege.\n\n#### Usage guidelines\n\n- The CSV file must have exactly three columns in this order: `content`, `locale`, `translated-content`.\n- Maximum file size: **30 MB**. Maximum rows: **10,000**.\n- Only `.csv` files are accepted.\n- The import performs an **upsert**: existing entries matched by `(org_id, locale, content)` are updated; new entries are inserted. Entries not in the upload are left untouched.\n- Set `scope` to `CLUSTER` to upload translations to the All-Org context. Cluster-level translations act as defaults for orgs that have no translations for a locale.\n- `scope` accepts only `ORG` (default) and `CLUSTER`, in uppercase. Any other value returns a `400` error.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Manual Translation", "26.7.0.cl" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "translations_file": { "description": "CSV file containing translations. The file must have three columns:\n`content`, `locale`, `translated-content`. Max file size: 30 MB.\nMax rows: 10,000.", "type": "string", "format": "binary" }, "scope": { "description": "Org scope for the import. `ORG` (default) targets the calling\nuser's current org. `CLUSTER` targets the All-Org context.", "default": "ORG", "type": "string", "enum": [ "ORG", "CLUSTER" ] } }, "required": [ "translations_file" ] } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Successfully imported manual translations." }, "400": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Operation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/worksheets/convert": { "post": { "operationId": "convertWorksheetToModel", "description": "\nConvert worksheets to models
Version: 10.6.0.cl or later\n\n## Prerequisites\n- **Privileges Required:**\n - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer ThoughtSpot).\n- **Additional Privileges (if RBAC is enabled):**\n - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (Can manage data models).\n\n---\n\n## Usage Guidelines\n\n### Parameters\n\n1. **worksheet_ids** \n - **Description:** A comma-separated list of GUIDs (Globally Unique Identifiers) specifying the Worksheets to be converted. \n - **Usage:** \n - Used only when `convert_all` is set to `false`. \n - Leave empty or omit when `convert_all` is set to `true`.\n\n2. **exclude_worksheet_ids** \n - **Description:** A comma-separated list of GUIDs specifying Worksheets to be excluded from conversion. \n - **Usage:** \n - Useful when `convert_all` is set to `true` and specific Worksheets should not be converted.\n\n3. **convert_all** \n - **Description:** Sets the scope of conversion.\n - **Options:** \n - `true`: Converts all Worksheets in the system, except those specified in `exclude_worksheet_ids`. \n - `false`: Converts only the Worksheets listed in `worksheet_ids`.\n\n4. **apply_changes** \n - **Description:** Specifies whether to apply changes directly to ThoughtSpot or to generate a preview before applying any changes.Used for validation of conversion.\n - **Options:** \n - `true`: Applies conversion changes directly to ThoughtSpot.\n - `false`: Generates only a preview of the changes and does not apply any changes to ThoughtSpot\n\n---\n\n## Best Practices\n\n1. **Backup Before Conversion:** \n Always export metadata as a backup before initiating the conversion process\n\n2. **Partial Conversion for Testing:** \n Test the conversion process by setting `convert_all` to `false` and specifying a small number of `worksheet_ids`.\n\n3. **Verify Dependencies:** \n Check for dependent objects, such as Tables and Connections, to avoid invalid references.\n\n4. **Review Changes:** \n Use `apply_changes: false` to preview the impact of the conversion before applying changes.\n\n---\n\n## Examples\n\n### Convert Specific Worksheets\n```json\n{\n \"worksheet_ids\": [\"guid1\", \"guid2\", \"guid3\"],\n \"exclude_worksheet_ids\": [],\n \"convert_all\": false,\n \"apply_changes\": true\n}\n```\n\n### Convert All Accessible Worksheets\n```json\n{\n \"worksheet_ids\": [],\n \"exclude_worksheet_ids\": [],\n \"convert_all\": true,\n \"apply_changes\": true\n}\n```\n\n### Exclude Specific Worksheets While Converting All Accessible Worksheets\n```json\n{\n \"worksheet_ids\": [],\n \"exclude_worksheet_ids\": [\"abc\"],\n \"convert_all\": true,\n \"apply_changes\": true\n}\n```\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", "10.6.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertWorksheetToModelRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Conversion of worksheets to model done successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseWorksheetToModelConversion" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/copyobject": { "post": { "operationId": "copyObject", "description": "\nMakes a copy of an Answer or Liveboard
Version: 10.3.0.cl or later\n\nCreates a copy of a metadata object.\n\nRequires at least view access to the metadata object being copied.\n\nUpon successful execution, the API creates a copy of the metadata object specified in the API request and returns the ID of the new object.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", "10.3.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyObjectRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Successfully created a copy of the object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseCopyObject" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Object not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/delete": { "post": { "operationId": "deleteMetadata", "description": "\n Version: 9.0.0.cl or later\n\nRemoves the specified metadata object from the ThoughtSpot system.\n\nRequires edit access to the metadata object. \n\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMetadataRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Metadata objects successfully deleted." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/tml/export": { "post": { "operationId": "exportMetadataTML", "description": "\n Version: 9.0.0.cl or later\n\nExports the [TML](https://docs.thoughtspot.com/cloud/latest/tml) representation of metadata objects in JSON or YAML format.\n\nRequires `DATADOWNLOADING` (**Can download Data**) and at least view access to the metadata object.\n\n#### Usage guidelines\n\n* You can export one or several objects by passing metadata object GUIDs in the `metadata` array.\n* When exporting TML content for a Liveboard or Answer object, you can set `export_associated` to `true` to retrieve TML content for underlying Worksheets, Tables, or Views, including the GUID of each object within the headers. When `export_associated` is set to `true`, consider retrieving one metadata object at a time.\n* Set `export_fqns` to `true` to add FQNs of the referenced objects in the TML content. For example, if you send an API request to retrieve TML for a Liveboard and its associated objects, the API returns the TML content with FQNs of the referenced Worksheet. Exporting TML with FQNs is useful if ThoughtSpot has multiple objects with the same name and you want to eliminate ambiguity when importing TML files into ThoughtSpot. It eliminates the need for adding FQNs of the referenced objects manually during the import operation.\n* To export only the TML of feedbacks associated with an object, set the GUID of the object as `identifier`, and set the `type` as `FEEDBACK` in the `metadata` array.\n* To export the TML of an object along with the feedbacks associated with it, set the GUID of the object as `identifier`, set the `type` as `LOGIAL_TABLE` in the `metadata` array, and set `export_with_associated_feedbacks` in `export_options` to true.\n\nFor more information, see [TML Documentation](https://developers.thoughtspot.com/docs/tml#_export_a_tml).\n\nFor more information on feedbacks, see [Feedback Documentation](https://docs.thoughtspot.com/cloud/latest/sage-feedback).\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportMetadataTMLRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Export TMLs of specified metadata objects is successful.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "example_1": { "summary": "Two objects exported successfully", "value": [ { "info": { "name": "Total sales by region", "filename": "Total sales by region.answer.tml", "status": { "status_code": "OK" }, "type": "ANSWER", "id": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b", "dependency": [ { "name": "Sales Model", "filename": "Sales Model.worksheet.tml" } ] }, "edoc": "guid: 4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b\nanswer:\n name: Total sales by region\n description: Total sales for each region\n tables:\n - id: Sales Model\n search_query: \"[sales] [region]\"\n answer_columns:\n - name: region\n - name: Total sales\n display_mode: CHART_MODE\n" }, { "info": { "name": "Snowflake Sales", "filename": "Snowflake Sales.connection.tml", "status": { "status_code": "OK" }, "type": "CONNECTION", "id": "5e6b4a3c-2f1d-4e8a-9b7c-0d1e2f3a4b5c", "dependency": [], "tables": [ { "name": "ORDERS", "filename": "ORDERS.table.tml" } ] }, "edoc": "guid: 5e6b4a3c-2f1d-4e8a-9b7c-0d1e2f3a4b5c\nconnection:\n name: Snowflake Sales\n type: RDBMS_SNOWFLAKE\n authentication_type: SERVICE_ACCOUNT\n properties:\n - key: accountName\n value: \"\"\n - key: role\n value: \"\"\n" } ] }, "example_2": { "summary": "One object exported, one failed", "value": [ { "info": { "name": "Total sales by region", "filename": "Total sales by region.answer.tml", "status": { "status_code": "OK" }, "type": "ANSWER", "id": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b", "dependency": [ { "name": "Sales Model", "filename": "Sales Model.worksheet.tml" } ] }, "edoc": "guid: 4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b\nanswer:\n name: Total sales by region\n description: Total sales for each region\n tables:\n - id: Sales Model\n search_query: \"[sales] [region]\"\n answer_columns:\n - name: region\n - name: Total sales\n display_mode: CHART_MODE\n" }, { "info": { "name": "Finance Liveboard", "status": { "status_code": "ERROR", "error_code": 10002, "error_message": "Object not found or not accessible." }, "type": "ANSWER", "id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d", "dependency": [ { "name": "Finance Model", "status": { "status_code": "ERROR", "error_message": "Dependency could not be exported." } } ] }, "edoc": "" } ] } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/tml/export/batch": { "post": { "operationId": "exportMetadataTMLBatched", "description": "\n Version: 10.1.0.cl or later\n\nExports the [TML](https://docs.thoughtspot.com/cloud/latest/tml) representation of metadata objects in JSON or YAML format.\n\n### **Permissions Required**\n\nRequires `DATAMANAGEMENT` (**Can manage data**) and `USERMANAGEMENT` (**Can manage users**) privileges.\n\n#### **Usage Guidelines**\n\nThis API is only applicable for `USER`, `GROUP`, and `ROLES` metadata types.\n\n- `batch_offset` Indicates the starting position within the complete dataset from which the API should begin returning objects. Useful for paginating results efficiently.\n- `batch_size` Specifies the number of objects or items to retrieve in a single request. Helps control response size for better performance.\n- `edoc_format` Defines the format of the TML content. The exported metadata can be in JSON or YAML format.\n- `export_dependent` Specifies whether to include dependent metadata objects in the export. Ensures related objects are also retrieved if needed.\n- `all_orgs_override` Indicates whether the export operation applies across all organizations. Useful for multi-tenant environments where cross-org exports are required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", "10.1.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportMetadataTMLBatchedRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Export TMLs of specified metadata objects is successful.", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "example_1": { "summary": "First batch of a batched TML export", "value": { "result": [ { "info": { "name": "Total sales by region", "filename": "Total sales by region.answer.tml", "status": { "status_code": "OK" }, "type": "ANSWER", "id": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b", "dependency": [ { "name": "Sales Model", "filename": "Sales Model.worksheet.tml" } ] }, "edoc": "guid: 4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b\nanswer:\n name: Total sales by region\n description: Total sales for each region\n tables:\n - id: Sales Model\n search_query: \"[sales] [region]\"\n answer_columns:\n - name: region\n - name: Total sales\n display_mode: CHART_MODE\n" }, { "info": { "name": "Snowflake Sales", "filename": "Snowflake Sales.connection.tml", "status": { "status_code": "OK" }, "type": "CONNECTION", "id": "5e6b4a3c-2f1d-4e8a-9b7c-0d1e2f3a4b5c", "dependency": [], "tables": [ { "name": "ORDERS", "filename": "ORDERS.table.tml" } ] }, "edoc": "guid: 5e6b4a3c-2f1d-4e8a-9b7c-0d1e2f3a4b5c\nconnection:\n name: Snowflake Sales\n type: RDBMS_SNOWFLAKE\n authentication_type: SERVICE_ACCOUNT\n properties:\n - key: accountName\n value: \"\"\n - key: role\n value: \"\"\n" } ], "isLastBatch": false, "batch_offset": 0, "batch_size": 2 } }, "example_2": { "summary": "Final batch, with one object that failed to export", "value": { "result": [ { "info": { "name": "Finance Liveboard", "status": { "status_code": "ERROR", "error_code": 10002, "error_message": "Object not found or not accessible." }, "type": "ANSWER", "id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d", "dependency": [ { "name": "Finance Model", "status": { "status_code": "ERROR", "error_message": "Dependency could not be exported." } } ] }, "edoc": "" } ], "isLastBatch": true, "batch_offset": 2, "batch_size": 2 } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/answer/sql": { "post": { "operationId": "fetchAnswerSqlQuery", "description": "\n Version: 9.0.0.cl or later\n\nFetches the underlying SQL query data for an Answer object.\n\nRequires at least view access to the Answer object.\n\nUpon successful execution, the API returns the SQL queries for the specified object as shown in this example:\n```\n{\n \"metadata_id\":\"8fbe44a8-46ad-4b16-8d39-184b2fada490\",\n \"metadata_name\":\"Total sales\",\n \"metadata_type\":\"ANSWER\",\n \"sql_queries\":[\n {\n \"metadata_id\":\"8fbe44a8-46ad-4b16-8d39-184b2fada490\",\n \"metadata_name\":\"Total sales -test\",\n \"sql_query\":\"SELECT \\n \\\"ta_1\\\".\\\"REGION\\\" \\\"ca_1\\\", \\n \\\"ta_2\\\".\\\"PRODUCTNAME\\\" \\\"ca_2\\\", \\n \\\"ta_1\\\".\\\"STORENAME\\\" \\\"ca_3\\\", \\n CASE\\n WHEN sum(\\\"ta_3\\\".\\\"SALES\\\") IS NOT NULL THEN sum(\\\"ta_3\\\".\\\"SALES\\\")\\n ELSE 0\\n END \\\"ca_4\\\", \\n CASE\\n WHEN sum(\\\"ta_3\\\".\\\"QUANTITYPURCHASED\\\") IS NOT NULL THEN sum(\\\"ta_3\\\".\\\"QUANTITYPURCHASED\\\")\\n ELSE 0\\n END \\\"ca_5\\\"\\nFROM \\\"RETAILAPPAREL\\\".\\\"PUBLIC\\\".\\\"FACT_RETAPP_SALES\\\" \\\"ta_3\\\"\\n JOIN \\\"RETAILAPPAREL\\\".\\\"PUBLIC\\\".\\\"DIM_RETAPP_STORES\\\" \\\"ta_1\\\"\\n ON \\\"ta_3\\\".\\\"STOREID\\\" = \\\"ta_1\\\".\\\"STOREID\\\"\\n JOIN \\\"RETAILAPPAREL\\\".\\\"PUBLIC\\\".\\\"DIM_RETAPP_PRODUCTS\\\" \\\"ta_2\\\"\\n ON \\\"ta_3\\\".\\\"PRODUCTID\\\" = \\\"ta_2\\\".\\\"PRODUCTID\\\"\\nGROUP BY \\n \\\"ca_1\\\", \\n \\\"ca_2\\\", \\n \\\"ca_3\\\"\\n\"\n }\n ]\n}\n```\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchAnswerSqlQueryRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Fetching SQL query of specified metadata object is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SqlQueryResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/tml/async/status": { "post": { "operationId": "fetchAsyncImportTaskStatus", "description": "\n Version: 10.4.0.cl or later\n\nGets information about the status of the TML async import task scheduled using the `/api/rest/2.0/metadata/tml/async/import` API call.\n\nTo fetch the task details, specify the ID of the TML async import task. \n\nRequires access to the task ID. The API allows users who initiated the asynchronous TML import via `/api/rest/2.0/metadata/tml/async/import` to view the status of their tasks. Users with administration privilege can view the status of all import tasks initiated by the users in their Org.\n\n#### Usage guidelines\n\nSee [TML API Documentation](https://developers.thoughtspot.com/docs/tml#_fetch_status_of_the_tml_import_task) for usage guidelines.\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", "10.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchAsyncImportTaskStatusRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Async TML Import Task statuses fetched successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAsyncImportStatusResponse" }, "examples": { "example": { "value": { "status_list": [ { "tenant_id": "", "org_id": 0, "task_id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a", "task_name": "Import sales objects", "import_response": { "object": [ { "name": "Sales Table", "guid": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b", "request_index": 0, "response": { "status": { "status_code": "OK" }, "header": { "id_guid": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b", "name": "Sales Table" } } }, { "name": "Sales Liveboard", "request_index": 1, "response": { "status": { "status_code": "ERROR", "error_message": "" } } } ] }, "task_status": "COMPLETED", "author_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "import_policy": "PARTIAL_OBJECT", "created_at": 1760198400000, "in_progress_at": 1760198401000, "completed_at": 1760198405000, "total_object_count": 2, "object_processed_count": 2, "modified_at": 1760198405000, "author_display_name": "" }, { "tenant_id": "", "org_id": 0, "task_id": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c", "task_name": "Import finance objects", "import_response": { "status": { "status_code": "ERROR", "error_message": "" } }, "task_status": "FAILED", "author_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "import_policy": "ALL_OR_NONE", "created_at": 1760198500000, "in_progress_at": 1760198501000, "completed_at": 1760198502000, "total_object_count": 3, "object_processed_count": 0, "modified_at": 1760198502000, "author_display_name": "" } ], "last_batch": true } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/liveboard/sql": { "post": { "operationId": "fetchLiveboardSqlQuery", "description": "\n Version: 9.0.0.cl or later\n\nFetches the underlying SQL query data for a Liveboard object and its visualizations.\n\nRequires at least view access to the Liveboard object.\n\nTo get SQL query data for a Liveboard, specify the GUID of the Liveboard. Optionally, you can add an array of visualization GUIDs to retrieve the SQL query data for visualizations in the Liveboard.\n\nUpon successful execution, the API returns the SQL queries for the specified object as shown in this example:\n```\n{\n \"metadata_id\": \"fa68ae91-7588-4136-bacd-d71fb12dda69\",\n \"metadata_name\": \"Total Sales\",\n \"metadata_type\": \"LIVEBOARD\",\n \"sql_queries\": [\n {\n \"metadata_id\": \"b3b6d2b9-089a-490c-8e16-b144650b7843\",\n \"metadata_name\": \"Total quantity purchased, Total sales by region\",\n \"sql_query\": \"SELECT \\n \\\"ta_1\\\".\\\"REGION\\\" \\\"ca_1\\\", \\n CASE\\n WHEN sum(\\\"ta_2\\\".\\\"QUANTITYPURCHASED\\\") IS NOT NULL THEN sum(\\\"ta_2\\\".\\\"QUANTITYPURCHASED\\\")\\n ELSE 0\\n END \\\"ca_2\\\", \\n CASE\\n WHEN sum(\\\"ta_2\\\".\\\"SALES\\\") IS NOT NULL THEN sum(\\\"ta_2\\\".\\\"SALES\\\")\\n ELSE 0\\n END \\\"ca_3\\\"\\nFROM \\\"RETAILAPPAREL\\\".\\\"PUBLIC\\\".\\\"FACT_RETAPP_SALES\\\" \\\"ta_2\\\"\\n JOIN \\\"RETAILAPPAREL\\\".\\\"PUBLIC\\\".\\\"DIM_RETAPP_STORES\\\" \\\"ta_1\\\"\\n ON \\\"ta_2\\\".\\\"STOREID\\\" = \\\"ta_1\\\".\\\"STOREID\\\"\\nGROUP BY \\\"ca_1\\\"\"\n }\n ]\n}\n```\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchLiveboardSqlQueryRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Fetching SQL query of specified metadata object is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SqlQueryResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/tml/import": { "post": { "operationId": "importMetadataTML", "description": "\n Version: 9.0.0.cl or later\n\nImports [TML](https://docs.thoughtspot.com/cloud/latest/tml) files into ThoughtSpot.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtsSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n#### Usage guidelines\n\n* Import all related objects in a single TML Import API call. For example, Tables that use the same Connection object and Worksheets connected to these Tables.\n* Include the `fqn` property to distinguish objects that have the same name.\n For example, if you have multiple Connections or Worksheets with the same name on ThoughtSpot and the Connection or Worksheet referenced in your TML file does not have a unique name to distinguish, it may result in invalid object references.\n Adding `fqn` helps ThoughtSpot differentiate a Table from another with the same name.\n We recommend [exporting TML with FQNs](#/http/api-endpoints/metadata/export-metadata-tml) and using these during the import operation.\n* You can upload multiple TML files at a time.\n If you import a Worksheet along with Liveboards, Answers, and other dependent objects in a single API call, the imported objects will be immediately available for use.\n When you import only a Worksheet object, it may take some time for the Worksheet to become available in the ThoughtSpot system. Please wait for a few minutes, and then proceed to create an Answer and Liveboard from the newly imported Worksheet.\n\nFor more information, see [TML Documentation](https://developers.thoughtspot.com/docs/tml#_import_a_tml).\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportMetadataTMLRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Import metadata objects using specified TMLs is successful.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "example": { "summary": "One object imported, one rejected", "value": [ { "name": "Sales Table", "guid": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b", "request_index": 0, "response": { "status": { "status_code": "OK" }, "header": { "id_guid": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b", "name": "Sales Table" } } }, { "name": "Sales Liveboard", "request_index": 1, "response": { "status": { "status_code": "ERROR", "error_message": "" } } } ] } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/tml/async/import": { "post": { "operationId": "importMetadataTMLAsync", "description": "\n Version: 10.4.0.cl or later\n\nSchedules a task to import [TML](https://docs.thoughtspot.com/cloud/latest/tml) files into ThoughtSpot. You can use this API endpoint to process TML objects asynchronously when importing TMLs of large and complex metadata objects into ThoughtSpot. Unlike the synchronous import TML operation, the API processes TML data in the background and returns a task ID, which can be used to check the status of the import task via `/api/rest/2.0/metadata/tml/async/status` API endpoint.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtsSpot**) privilege, and edit access to the TML objects.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**)\n\n#### Usage guidelines\n\nSee [Async TML API Documentation](https://developers.thoughtspot.com/docs/tml#_import_tml_objects_asynchronously) for usage guidelines.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", "10.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportMetadataTMLAsyncRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Async TML Import Task submitted successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportEPackAsyncTaskStatus" }, "examples": { "example": { "value": { "tenant_id": "", "org_id": 0, "task_id": "3d4e5f6a-7b8c-4d9e-8f0a-1b2c3d4e5f6a", "task_name": "Import sales objects", "task_status": "IN_QUEUE", "author_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "import_policy": "PARTIAL_OBJECT", "created_at": 1760198400000, "total_object_count": 2, "object_processed_count": 0, "modified_at": 1760198400000, "author_display_name": "" } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/parameterize": { "post": { "operationId": "parameterizeMetadata", "description": "\nParameterize fields in metadata objects.
Beta Version: 10.9.0.cl or later\n\n**Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/metadata/parameterize-fields](/api/rest/2.0/metadata/parameterize-fields) instead.\n\nAllows parameterizing fields in metadata objects in ThoughtSpot.\n\nRequires appropriate permissions to modify the metadata object.\n\nThe API endpoint allows parameterizing the following types of metadata objects:\n* Logical Tables\n* Connections\n* Connection Configs\n\nFor a Logical Table the field type must be `ATTRIBUTE` and field name can be one of:\n* databaseName\n* schemaName\n* tableName\n\nFor a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_name specifies the exact property of the Connection or Connection Config that needs to be parameterized.\n\nFor Connection Config, the only supported field name is:\n* impersonate_user\n\n\n\n\n#### Endpoint URL\n", "deprecated": true, "tags": [ "Metadata", "10.9.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParameterizeMetadataRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Parameterize successful." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/parameterize-fields": { "post": { "operationId": "parameterizeMetadataFields", "description": "\nParameterize multiple fields of metadata objects. For example [schemaName, databaseName] for LOGICAL_TABLE.
Version: 26.5.0.cl or later\n\nGA Version: 26.10.0.cl or later\n\nAllows parameterizing multiple fields of metadata objects in ThoughtSpot. For example, you can parameterize [schemaName, databaseName] for LOGICAL_TABLE.\n\nRequires appropriate permissions to modify the metadata object.\n\nThe API endpoint allows parameterizing the following types of metadata objects:\n* Logical Tables\n* Connections\n* Connection Configs\n\nFor a Logical Table, the field type must be `ATTRIBUTE` and field names can include:\n* databaseName\n* schemaName\n* tableName\n\nFor a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_names specifies the exact properties of the Connection or Connection Config that need to be parameterized.\n\nFor Connection Config, supported field names include:\n* impersonate_user\n\nYou can parameterize multiple fields at once by providing an array of field names.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", "26.5.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParameterizeMetadataFieldsRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Parameterize successful." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/search": { "post": { "operationId": "searchMetadata", "description": "\n Version: 9.0.0.cl or later\n\nGets a list of metadata objects available on the ThoughtSpot system.\n\nThis API endpoint is available to all users who have view access to the object. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view data for all metadata objects, including users and groups.\n\n#### Usage guidelines\n\n- To get all metadata objects, send the API request without any attributes.\n- To get metadata objects of a specific type, set the `type` attribute. For example, to fetch a Worksheet, set the type as `LOGICAL_TABLE`.\n- To filter metadata objects within type `LOGICAL_TABLE`, set the `subtypes` attribute. For example, to fetch a Worksheet, set the type as `LOGICAL_TABLE` & subtypes as `[WORKSHEET]`.\n- To get a specific metadata object, specify the GUID.\n- To customize your search and filter the API response, you can use several parameters.\n You can search for objects created or modified by specific users, by tags applied to the objects, or by using the include parameters like `include_auto_created_objects`, `include_dependent_objects`, `include_headers`, `include_incomplete_objects`, and so on.\n You can also define sorting options to sort the data retrieved in the API response.\n- To get discoverable objects when linientmodel is enabled you can use `include_discoverable_objects` as true else false. Default value is true.\n- For liveboard metadata type, to get the newer format, set the `liveboard_response_format` as V2. Default value is V1.\n- To retrieve only objects that are published, set the `include_only_published_objects` as true. Default value is false.\n\n**NOTE**: `obj_identifier` is supported for the following object types: `LIVEBOARD`, `ANSWER`, `LOGICAL_TABLE`, `LOGICAL_COLUMN`, `CONNECTION`, `USER_GROUP`, `COLLECTION`. The response includes the `metadata_obj_id` field for objects that have a Custom object ID set.\n\n**NOTE**: The following parameters support pagination of metadata records:\n\n- `tag_identifiers`\n- `type`\n- `subtypes`\n- `created_by_user_identifiers`\n- `modified_by_user_identifiers`\n- `owned_by_user_identifiers`\n- `exclude_objects`\n- `include_auto_created_objects`\n- `favorite_object_options`\n- `include_only_published_objects`\n\n**Warning**: Do not set `record_size` to `-1`. On ThoughtSpot instances with a large number of objects or users, this can lead to slow responses, excessive logging, and out-of-memory failures. Specify an explicit `record_size` and iterate through pages programmatically.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchMetadataRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Metadata objects search result.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataSearchResponse" } }, "examples": { "example": { "value": [ { "metadata_id": "00000001-0000-4000-8000-000000000001", "metadata_name": "Parameters Liveboard", "metadata_type": "LIVEBOARD", "metadata_obj_id": null, "dependent_objects": { "00000001-0000-4000-8000-000000000001": {} }, "dependent_objects_is_last_batch": null, "incomplete_objects": null, "metadata_detail": { "reportContent": { "sheets": [ { "sheetType": "PINBOARD", "sheetContent": { "sheetContentType": "PINBOARD", "pinboardFilterDetails": { "pinboardFiltersAnswerIds": [], "filterLogicalTableIds": [], "logicalTableIdToPinboardFilterVizIds": { "2b3c4d5e-0003-4f6a-9b7c-8d9e0f1a2b3c": [ "3c4d5e6f-0004-4a7b-8c8d-9e0f1a2b3c4d", "4d5e6f7a-0005-4b8c-9d9e-0f1a2b3c4d5e" ] }, "filterIdToLinkedFilterIds": { "1a2b3c4d-0001-4e5f-8a6b-7c8d9e0f1a2b": [ "1a2b3c4d-0002-4e5f-8a6b-7c8d9e0f1a2b" ] }, "filterIdToExcludedVizs": { "1a2b3c4d-0001-4e5f-8a6b-7c8d9e0f1a2b": [ "4d5e6f7a-0005-4b8c-9d9e-0f1a2b3c4d5e" ] } }, "visualizations": [ { "vizContent": { "refAnswerSheetIndex": 0, "refVizId": "00000002-0000-4000-8000-000000000002", "locked": false, "dataOnDemand": false, "refAnswerBook": { "id": "00000003-0000-4000-8000-000000000003", "name": "Total Partial Revenue", "sheets": [ { "id": "00000004-0000-4000-8000-000000000004", "name": "Total Partial Revenue", "owner": "00000003-0000-4000-8000-000000000003" } ] }, "vizType": "PINBOARD_VIZ" }, "relatedLinks": [], "header": { "id": "00000005-0000-4000-8000-000000000005", "indexVersion": 27, "generationNum": 28, "name": "Answer: Total Partial Revenue Viz: Chart Viz holiday ytd", "author": "00000006-0000-4000-8000-000000000006", "authorName": "", "hasLenientDiscoverability": false, "authorDisplayName": "", "created": 1760198400000, "modified": 1760198460000, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "00000001-0000-4000-8000-000000000001", "isDeleted": false, "isHidden": false, "tags": [], "configs": [], "isConnectionConfigurationDisabled": false, "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false, "syncWithSource": false, "isParameterized": false, "cachedDataAsOf": 0, "isVerified": false, "isVersioningEnabled": false, "contentUpgradeId": "", "headerUpgradeId": "", "isPublished": false, "csrProtected": false }, "complete": true, "incompleteDetail": [] } ], "layout": { "layoutMode": "auto", "tiles": [ { "id": "00000005-0000-4000-8000-000000000005", "x": 0, "y": 0, "width": 0, "height": 0, "order": 0, "size": "xs" } ] }, "vizLayout": "", "canGenerateLeafData": false }, "header": { "id": "00000007-0000-4000-8000-000000000007", "indexVersion": 28, "generationNum": 28, "name": "Parameters Liveboard", "description": "", "author": "00000006-0000-4000-8000-000000000006", "authorName": "", "hasLenientDiscoverability": false, "authorDisplayName": "", "created": 1760198400000, "modified": 1760198460000, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "00000001-0000-4000-8000-000000000001", "isDeleted": false, "isHidden": false, "tags": [], "configs": [], "isConnectionConfigurationDisabled": false, "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false, "syncWithSource": false, "isParameterized": false, "cachedDataAsOf": 0, "isVerified": false, "isVersioningEnabled": false, "contentUpgradeId": "", "headerUpgradeId": "", "isPublished": false, "csrProtected": false }, "complete": true, "incompleteDetail": [] } ] }, "type": "PINBOARD", "header": { "hasTabs": false, "modelVersion": "V1", "hasMandatoryFilter": false, "isMandatoryFilterValueSelected": true, "totalContainerCount": 4, "id": "00000001-0000-4000-8000-000000000001", "indexVersion": 28, "generationNum": 28, "name": "Parameters Liveboard", "description": "", "author": "00000006-0000-4000-8000-000000000006", "authorName": "", "hasLenientDiscoverability": false, "descriptionAutoGenerated": false, "authorDisplayName": "", "created": 1760198400000, "modified": 1760198460000, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "00000001-0000-4000-8000-000000000001", "isDeleted": false, "isHidden": false, "isAutoCreated": false, "isAutoDelete": false, "ownerOrgId": 0, "resolvedObjects": { "00000002-0000-4000-8000-000000000002": { "reportContent": { "sheets": [ { "sheetType": "QUESTION", "sheetContent": { "headlineVisibilityMap": { "00000008-0000-4000-8000-000000000008": false }, "defaultQueryableSource": "FALCON", "querableSources": [ "FALCON" ], "externalQueryableDataSource": "DEFAULT", "displayMode": "CHART_MODE", "bestDisplayMode": "CHART_MODE", "canGenerateLeafData": true, "sheetContentType": "QUESTION", "filter": { "filterContent": { "rows": [ { "column": { "isUserSorted": false, "aggrTypeOverride": "NONE", "typeOverride": "UNKNOWN", "dataTypeOverride": "UNKNOWN", "formatTypeOverride": "NONE", "uniqueValues": 0, "sageOutputColumnId": "00000009-0000-4000-8000-000000000009", "outputIdsWithMatchingLogicalKey": [], "aggrApplied": false, "isVisible": true, "columnToFormatPatternType": {}, "effectiveAggrType": "NONE", "effectiveDataType": "BOOL", "effectiveType": "ATTRIBUTE", "id": "00000009-0000-4000-8000-000000000009", "effectiveColumnGuid": "0000000a-0000-4000-8000-00000000000a", "effectiveColumnIdString": "0000000b-0000-4000-8000-00000000000b#NONE#ATTRIBUTE#null", "baseColumnName": "Holiday YTD", "baseColumnFormulaId": "0000000c-0000-4000-8000-00000000000c", "baseAggrType": "NONE", "baseDataType": "BOOL", "baseType": "ATTRIBUTE", "isBaseColumnFormulaColumn": true, "isBaseColumnAdditive": false, "referencedTableHeaders": [ { "id": "0000000d-0000-4000-8000-00000000000d", "name": "Parameters WS" } ], "referencedColumnHeaders": [ { "id": "0000000e-0000-4000-8000-00000000000e", "name": "Commit Date" } ], "allLevelReferencedTableHeaders": [ { "id": "0000000d-0000-4000-8000-00000000000d", "name": "Parameters WS" } ], "allLevelReferencedColumnHeaders": [ { "id": "0000000e-0000-4000-8000-00000000000e", "name": "Commit Date" } ] }, "oper": "EQ", "values": [ { "key": "true", "selected": true } ], "negation": false, "applyOnTablesGuids": [], "type": "SIMPLE" } ] }, "header": { "id": "0000000f-0000-4000-8000-00000000000f", "indexVersion": 27, "generationNum": 28, "name": "Filter holiday ytd = true partial revenue", "author": "00000006-0000-4000-8000-000000000006", "authorName": "", "hasLenientDiscoverability": false, "authorDisplayName": "", "created": 1760198400000, "modified": 1760198460000, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "00000004-0000-4000-8000-000000000004", "isDeleted": false, "isHidden": false, "tags": [], "configs": [], "isConnectionConfigurationDisabled": false, "type": "QUESTION", "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false, "syncWithSource": false, "isParameterized": false, "cachedDataAsOf": 0, "isVerified": false, "isVersioningEnabled": false, "contentUpgradeId": "", "headerUpgradeId": "", "isPublished": false, "csrProtected": false }, "complete": true, "incompleteDetail": [] }, "question": { "sageContextProto": "", "sageContextIndex": 0, "text": "holiday ytd = true partial revenue", "isChasmTrapQuery": false }, "visualizations": [ { "vizContent": { "chartType": "KPI", "axisConfigs": [ { "y": [ "00000008-0000-4000-8000-000000000008" ] } ], "bestAxisConfigs": { "KPI": [ { "y": [ "00000008-0000-4000-8000-000000000008" ] } ] }, "title": { "value": { "text": "Chart 0" } }, "customTitle": false, "locked": false, "dataOnDemand": false, "columns": [ { "isUserSorted": false, "aggrTypeOverride": "SUM", "typeOverride": "MEASURE", "dataTypeOverride": "UNKNOWN", "formatTypeOverride": "NONE", "groupBy": false, "uniqueValues": -1, "sageOutputColumnId": "00000008-0000-4000-8000-000000000008", "outputIdsWithMatchingLogicalKey": [], "aggrApplied": true, "isVisible": true, "columnToFormatPatternType": {}, "effectiveAggrType": "SUM", "effectiveDataType": "DOUBLE", "effectiveType": "MEASURE", "id": "00000008-0000-4000-8000-000000000008", "effectiveColumnGuid": "00000010-0000-4000-8000-000000000010", "effectiveColumnIdString": "00000011-0000-4000-8000-000000000011#SUM#MEASURE#null", "baseColumnName": "Partial Revenue", "baseColumnFormulaId": "00000012-0000-4000-8000-000000000012", "baseAggrType": "SUM", "baseDataType": "DOUBLE", "baseType": "MEASURE", "isBaseColumnFormulaColumn": true, "isBaseColumnAdditive": true, "referencedTableHeaders": [ { "id": "0000000d-0000-4000-8000-00000000000d", "name": "Parameters WS" } ], "referencedColumnHeaders": [ { "id": "00000013-0000-4000-8000-000000000013", "name": "Revenue" } ], "allLevelReferencedTableHeaders": [ { "id": "0000000d-0000-4000-8000-00000000000d", "name": "Parameters WS" } ], "allLevelReferencedColumnHeaders": [ { "id": "00000013-0000-4000-8000-000000000013", "name": "Revenue" } ] } ], "vizType": "CHART" }, "relatedLinks": [], "header": { "id": "00000002-0000-4000-8000-000000000002", "indexVersion": 27, "generationNum": 28, "name": "Chart Viz holiday ytd = true partial revenue", "author": "00000006-0000-4000-8000-000000000006", "authorName": "", "hasLenientDiscoverability": false, "authorDisplayName": "", "created": 1760198400000, "modified": 1760198460000, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "00000004-0000-4000-8000-000000000004", "isDeleted": false, "isHidden": false, "tags": [], "configs": [], "isConnectionConfigurationDisabled": false, "type": "QUESTION", "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false, "syncWithSource": false, "isParameterized": false, "cachedDataAsOf": 0, "isVerified": false, "isVersioningEnabled": false, "contentUpgradeId": "", "headerUpgradeId": "", "isPublished": false, "csrProtected": false }, "complete": true, "incompleteDetail": [] }, { "vizContent": { "vizType": "TABLE", "columns": [ { "isUserSorted": false, "aggrTypeOverride": "SUM", "typeOverride": "MEASURE", "dataTypeOverride": "UNKNOWN", "formatTypeOverride": "NONE", "groupBy": false, "uniqueValues": -1, "sageOutputColumnId": "00000008-0000-4000-8000-000000000008", "outputIdsWithMatchingLogicalKey": [], "aggrApplied": true, "isVisible": true, "columnToFormatPatternType": {}, "effectiveAggrType": "SUM", "effectiveDataType": "DOUBLE", "effectiveType": "MEASURE", "id": "00000008-0000-4000-8000-000000000008", "effectiveColumnGuid": "00000010-0000-4000-8000-000000000010", "effectiveColumnIdString": "00000011-0000-4000-8000-000000000011#SUM#MEASURE#null", "baseColumnName": "Partial Revenue", "baseColumnFormulaId": "00000012-0000-4000-8000-000000000012", "baseAggrType": "SUM", "baseDataType": "DOUBLE", "baseType": "MEASURE", "isBaseColumnFormulaColumn": true, "isBaseColumnAdditive": true, "referencedTableHeaders": [ { "id": "0000000d-0000-4000-8000-00000000000d", "name": "Parameters WS" } ], "referencedColumnHeaders": [ { "id": "00000013-0000-4000-8000-000000000013", "name": "Revenue" } ], "allLevelReferencedTableHeaders": [ { "id": "0000000d-0000-4000-8000-00000000000d", "name": "Parameters WS" } ], "allLevelReferencedColumnHeaders": [ { "id": "00000013-0000-4000-8000-000000000013", "name": "Revenue" } ] } ], "title": { "value": { "text": "Table 1" } }, "customTitle": false, "locked": false }, "relatedLinks": [], "header": { "id": "00000014-0000-4000-8000-000000000014", "indexVersion": 27, "generationNum": 28, "name": "Table Viz holiday ytd = true partial revenue", "author": "00000006-0000-4000-8000-000000000006", "authorName": "", "hasLenientDiscoverability": false, "authorDisplayName": "", "created": 1760198400000, "modified": 1760198460000, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "00000004-0000-4000-8000-000000000004", "isDeleted": false, "isHidden": false, "tags": [], "configs": [], "isConnectionConfigurationDisabled": false, "type": "QUESTION", "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false, "syncWithSource": false, "isParameterized": false, "cachedDataAsOf": 0, "isVerified": false, "isVersioningEnabled": false, "contentUpgradeId": "", "headerUpgradeId": "", "isPublished": false, "csrProtected": false }, "complete": true, "incompleteDetail": [] }, { "vizContent": { "vizType": "FILTER", "compoundRowIndices": [ 0 ], "dataOnDemand": true }, "relatedLinks": [], "header": { "id": "00000015-0000-4000-8000-000000000015", "indexVersion": 27, "generationNum": 28, "name": "Filter Viz output id: 00000009-0000-4000-8000-000000000009", "author": "00000006-0000-4000-8000-000000000006", "authorName": "", "hasLenientDiscoverability": false, "authorDisplayName": "", "created": 1760198400000, "modified": 1760198460000, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "00000004-0000-4000-8000-000000000004", "isDeleted": false, "isHidden": false, "tags": [], "configs": [], "isConnectionConfigurationDisabled": false, "type": "QUESTION", "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false, "syncWithSource": false, "isParameterized": false, "cachedDataAsOf": 0, "isVerified": false, "isVersioningEnabled": false, "contentUpgradeId": "", "headerUpgradeId": "", "isPublished": false, "csrProtected": false }, "complete": true, "incompleteDetail": [] } ] }, "header": { "id": "00000004-0000-4000-8000-000000000004", "indexVersion": 27, "generationNum": 28, "name": "Total Partial Revenue", "author": "00000006-0000-4000-8000-000000000006", "authorName": "", "hasLenientDiscoverability": false, "authorDisplayName": "", "created": 1760198400000, "modified": 1760198460000, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "00000003-0000-4000-8000-000000000003", "isDeleted": false, "isHidden": true, "tags": [], "configs": [], "isConnectionConfigurationDisabled": false, "type": "QUESTION", "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false, "syncWithSource": false, "isParameterized": false, "cachedDataAsOf": 0, "isVerified": false, "isVersioningEnabled": false, "contentUpgradeId": "", "headerUpgradeId": "", "isPublished": false, "csrProtected": false }, "complete": true, "incompleteDetail": [] } ] }, "type": "QUESTION", "header": { "isTimeSeriesKPI": false, "referencedVizType": "CHART", "chartType": "KPI", "id": "00000003-0000-4000-8000-000000000003", "indexVersion": 27, "generationNum": 28, "name": "Total Partial Revenue", "author": "00000006-0000-4000-8000-000000000006", "authorName": "", "hasLenientDiscoverability": false, "descriptionAutoGenerated": false, "authorDisplayName": "", "created": 1760198400000, "modified": 1760198460000, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "00000001-0000-4000-8000-000000000001", "isDeleted": false, "isHidden": true, "isAutoCreated": false, "isAutoDelete": false, "ownerOrgId": 0, "resolvedObjects": {}, "tags": [], "configs": [], "isConnectionConfigurationDisabled": false, "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false, "syncWithSource": false, "isParameterized": false, "cachedDataAsOf": 0, "isVerified": false, "isVersioningEnabled": false, "datasetId": "", "subType": "", "reportId": "", "viewId": "", "contentUpgradeId": "", "headerUpgradeId": "", "isPublished": false, "csrProtected": false }, "complete": true, "incompleteDetail": [] } }, "tags": [ { "id": "00000016-0000-4000-8000-000000000016", "indexVersion": 0, "generationNum": 38, "name": "try me", "author": "00000006-0000-4000-8000-000000000006", "created": 1412881252884, "modified": 1412881301302, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "00000016-0000-4000-8000-000000000016", "isDeleted": false, "isHidden": false, "clientState": { "color": "#fbc17c" }, "orgIds": [ 0 ], "tags": [], "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false } ], "configs": [ { "id": "00000017-0000-4000-8000-000000000017", "name": "Connection configuration", "author": "00000006-0000-4000-8000-000000000006", "created": 1760198400000, "modified": 1760198400000, "isDeleted": false, "isHidden": false } ], "isConnectionConfigurationDisabled": false, "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false, "syncWithSource": false, "isParameterized": false, "cachedDataAsOf": 0, "isVerified": false, "isVersioningEnabled": false, "datasetId": "", "subType": "", "reportId": "", "viewId": "", "contentUpgradeId": "", "headerUpgradeId": "", "isPublished": false, "csrProtected": false }, "complete": true, "incompleteDetail": [], "personalised_views": [ { "guid": "00000018-0000-4000-8000-000000000018", "name": "My view", "isPublic": false, "author": "00000006-0000-4000-8000-000000000006", "authorDisplayName": "", "createdAt": 1760198460000, "updatedAt": 1760198460000 } ] }, "metadata_header": { "hasTabs": false, "modelVersion": "V1", "hasMandatoryFilter": false, "isMandatoryFilterValueSelected": true, "totalContainerCount": 4, "id": "00000001-0000-4000-8000-000000000001", "indexVersion": 28, "generationNum": 28, "name": "Parameters Liveboard", "description": "", "author": "00000006-0000-4000-8000-000000000006", "authorName": "", "hasLenientDiscoverability": false, "descriptionAutoGenerated": false, "authorDisplayName": "", "created": 1760198400000, "modified": 1760198460000, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "00000001-0000-4000-8000-000000000001", "isDeleted": false, "isHidden": false, "isAutoCreated": false, "isAutoDelete": false, "ownerOrgId": 0, "resolvedObjects": {}, "tags": [ { "id": "00000016-0000-4000-8000-000000000016", "indexVersion": 0, "generationNum": 38, "name": "try me", "author": "00000006-0000-4000-8000-000000000006", "created": 1412881252884, "modified": 1412881301302, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "00000016-0000-4000-8000-000000000016", "isDeleted": false, "isHidden": false, "clientState": { "color": "#fbc17c" }, "orgIds": [ 0 ], "tags": [], "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false } ], "configs": [ { "id": "00000017-0000-4000-8000-000000000017", "name": "Connection configuration", "author": "00000006-0000-4000-8000-000000000006", "created": 1760198400000, "modified": 1760198400000, "isDeleted": false, "isHidden": false } ], "isConnectionConfigurationDisabled": false, "type": "", "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false, "syncWithSource": false, "isParameterized": false, "cachedDataAsOf": 0, "isVerified": false, "isVersioningEnabled": false, "datasetId": "", "subType": "", "reportId": "", "viewId": "", "contentUpgradeId": "", "headerUpgradeId": "", "isPublished": false, "csrProtected": false }, "visualization_headers": [ { "size": "xs", "vizType": "CHART", "title": { "value": { "text": "Chart 0" } }, "id": "00000005-0000-4000-8000-000000000005", "name": "Total Partial Revenue", "author": "00000006-0000-4000-8000-000000000006", "created": 1760198400000, "modified": 1760198460000, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "00000001-0000-4000-8000-000000000001" } ], "stats": { "views": 42, "favorites": 3, "last_accessed": 1760198460000 } }, { "metadata_id": "00000019-0000-4000-8000-000000000019", "metadata_name": "Sales collection", "metadata_type": "COLLECTION", "metadata_obj_id": "sales-collection-4d4a779a", "dependent_objects": { "00000019-0000-4000-8000-000000000019": {} }, "dependent_objects_is_last_batch": true, "incomplete_objects": [ { "code": "BASE_OBJECT_MISSING", "codeNumber": 10005, "message": "Missing owner GUID for storable: {\"id\":\"00000019-0000-4000-8000-000000000019\",\"name\":\"Sales collection\",\"type\":\"Folder\"}", "header": { "id": "00000019-0000-4000-8000-000000000019", "indexVersion": 156, "generationNum": 156, "name": "Sales collection", "description": "", "author": "00000006-0000-4000-8000-000000000006", "created": 1791476207822, "modified": 1791476219803, "modifiedBy": "00000006-0000-4000-8000-000000000006", "isDeleted": false, "isHidden": false, "ownerOrgId": 0, "tags": [], "configs": [], "isConnectionConfigurationDisabled": false, "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false, "syncWithSource": false, "isParameterized": false, "cachedDataAsOf": 0, "isVerified": false, "isVersioningEnabled": false, "objId": "sales-collection-4d4a779a", "contentUpgradeId": "", "headerUpgradeId": "", "isPublished": false, "csrProtected": false }, "type": "FOLDER" } ], "metadata_detail": { "folderContent": { "schemaVersion": "3.1.0" }, "assignedEntities": [ "0000001a-0000-4000-8000-00000000001a", "00000001-0000-4000-8000-000000000001" ], "inheritedFolders": [ "0000001b-0000-4000-8000-00000000001b" ], "state": "ACTIVE", "visibility": "SHARABLE", "header": { "id": "00000019-0000-4000-8000-000000000019", "indexVersion": 156, "generationNum": 156, "name": "Sales collection", "description": "", "author": "00000006-0000-4000-8000-000000000006", "created": 1791476207822, "modified": 1791476219803, "modifiedBy": "00000006-0000-4000-8000-000000000006", "isDeleted": false, "isHidden": false, "ownerOrgId": 0, "tags": [], "configs": [], "isConnectionConfigurationDisabled": false, "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false, "syncWithSource": false, "isParameterized": false, "cachedDataAsOf": 0, "isVerified": false, "isVersioningEnabled": false, "objId": "sales-collection-4d4a779a", "contentUpgradeId": "", "headerUpgradeId": "", "isPublished": false, "csrProtected": false }, "complete": false, "incompleteDetail": [ { "code": "BASE_OBJECT_MISSING", "codeNumber": 10005, "message": "Missing owner GUID for storable: {\"id\":\"00000019-0000-4000-8000-000000000019\",\"name\":\"Sales collection\",\"type\":\"Folder\"}", "header": { "id": "00000019-0000-4000-8000-000000000019", "indexVersion": 156, "generationNum": 156, "name": "Sales collection", "description": "", "author": "00000006-0000-4000-8000-000000000006", "created": 1791476207822, "modified": 1791476219803, "modifiedBy": "00000006-0000-4000-8000-000000000006", "isDeleted": false, "isHidden": false, "ownerOrgId": 0, "tags": [], "configs": [], "isConnectionConfigurationDisabled": false, "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false, "syncWithSource": false, "isParameterized": false, "cachedDataAsOf": 0, "isVerified": false, "isVersioningEnabled": false, "objId": "sales-collection-4d4a779a", "contentUpgradeId": "", "headerUpgradeId": "", "isPublished": false, "csrProtected": false }, "type": "FOLDER" } ] }, "metadata_header": { "id": "00000019-0000-4000-8000-000000000019", "indexVersion": 156, "generationNum": 156, "name": "Sales collection", "description": "", "author": "00000006-0000-4000-8000-000000000006", "authorName": "", "authorDisplayName": "", "created": 1791476207822, "modified": 1791476219803, "modifiedBy": "00000006-0000-4000-8000-000000000006", "isDeleted": false, "isHidden": false, "ownerOrgId": 0, "tags": [], "configs": [], "isConnectionConfigurationDisabled": false, "type": "", "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false, "syncWithSource": false, "isParameterized": false, "cachedDataAsOf": 0, "isVerified": false, "isVersioningEnabled": false, "subType": "", "objId": "sales-collection-4d4a779a", "contentUpgradeId": "", "headerUpgradeId": "", "isPublished": false, "csrProtected": false }, "visualization_headers": null, "stats": null }, { "metadata_id": "0000001c-0000-4000-8000-00000000001c", "metadata_name": "", "metadata_type": "ANSWER", "dependent_objects": null, "incomplete_objects": null, "metadata_detail": null, "metadata_header": { "id": "0000001c-0000-4000-8000-00000000001c", "indexVersion": 36, "generationNum": 36, "name": "", "description": "", "author": "00000006-0000-4000-8000-000000000006", "authorName": "", "hasLenientDiscoverability": false, "authorDisplayName": "", "created": 1519761648892, "modified": 1583190990050, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "0000001c-0000-4000-8000-00000000001c", "isDeleted": false, "isHidden": false, "isAutoCreated": false, "isAutoDelete": false, "clientState": { "queryState": "FALCON" }, "orgIds": [ 0 ], "tags": [], "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false }, "visualization_headers": null, "stats": null }, { "metadata_id": "0000001d-0000-4000-8000-00000000001d", "metadata_name": "", "metadata_type": "LOGICAL_TABLE", "dependent_objects": null, "incomplete_objects": null, "metadata_detail": null, "metadata_header": { "id": "0000001d-0000-4000-8000-00000000001d", "indexVersion": 34, "generationNum": 34, "name": "", "author": "00000006-0000-4000-8000-000000000006", "authorName": "", "authorDisplayName": "", "created": 1455598151033, "modified": 1455598151033, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "0000001d-0000-4000-8000-00000000001d", "isDeleted": false, "isHidden": false, "orgIds": [ 0 ], "tags": [], "type": "WORKSHEET", "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false }, "visualization_headers": null, "stats": null }, { "metadata_id": "0000001e-0000-4000-8000-00000000001e", "metadata_name": "", "metadata_type": "LOGICAL_COLUMN", "dependent_objects": null, "incomplete_objects": null, "metadata_detail": null, "metadata_header": { "id": "0000001e-0000-4000-8000-00000000001e", "indexVersion": 34, "generationNum": 34, "name": "", "author": "00000006-0000-4000-8000-000000000006", "created": 1455598151033, "modified": 1455598151033, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "0000001d-0000-4000-8000-00000000001d", "isDeleted": false, "isHidden": false, "orgIds": [ 0 ], "tags": [], "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false }, "visualization_headers": null, "stats": null }, { "metadata_id": "0000001f-0000-4000-8000-00000000001f", "metadata_name": "", "metadata_type": "CONNECTION", "dependent_objects": null, "incomplete_objects": null, "metadata_detail": null, "metadata_header": { "dataUploadEnabled": false, "id": "0000001f-0000-4000-8000-00000000001f", "indexVersion": 29, "generationNum": 29, "name": "", "description": "", "author": "00000006-0000-4000-8000-000000000006", "authorName": "", "hasLenientDiscoverability": false, "authorDisplayName": "", "created": 1565611520983, "modified": 1565611520983, "relationWithUser": "ADMINISTRATOR", "modifiedBy": "00000020-0000-4000-8000-000000000020", "owner": "0000001f-0000-4000-8000-00000000001f", "isDeleted": false, "isHidden": false, "isAutoCreated": false, "isAutoDelete": false, "statistics": { "dataLoadStatistics": { "scheduled": false, "connectionType": "", "connectionDisplayName": "", "dataLoadStatusList": [], "header": { "id": "00000021-0000-4000-8000-000000000021", "indexVersion": 29, "generationNum": 29, "author": "00000006-0000-4000-8000-000000000006", "owner": "0000001f-0000-4000-8000-00000000001f", "isDeleted": false, "isHidden": false, "orgIds": [ 0 ], "tags": [], "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false }, "complete": true, "incompleteDetail": [] } }, "orgIds": [ 0 ], "resolvedObjects": {}, "tags": [], "type": "RDBMS_SNOWFLAKE", "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false }, "visualization_headers": null, "stats": null }, { "metadata_id": "00000016-0000-4000-8000-000000000016", "metadata_name": "", "metadata_type": "TAG", "dependent_objects": null, "incomplete_objects": null, "metadata_detail": null, "metadata_header": { "id": "00000016-0000-4000-8000-000000000016", "indexVersion": 0, "generationNum": 38, "name": "", "author": "00000006-0000-4000-8000-000000000006", "created": 1412881252884, "modified": 1412881301302, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "00000016-0000-4000-8000-000000000016", "isDeleted": false, "isHidden": false, "clientState": { "color": "" }, "orgIds": [ 0 ], "tags": [], "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false }, "visualization_headers": null, "stats": null }, { "metadata_id": "00000020-0000-4000-8000-000000000020", "metadata_name": "", "metadata_type": "USER", "dependent_objects": null, "incomplete_objects": null, "metadata_detail": null, "metadata_header": { "id": "00000020-0000-4000-8000-000000000020", "indexVersion": 169, "generationNum": 169, "name": "", "displayName": "", "author": "00000020-0000-4000-8000-000000000020", "created": 1354006445722, "modified": 1354006445987, "modifiedBy": "00000020-0000-4000-8000-000000000020", "owner": "00000020-0000-4000-8000-000000000020", "isDeleted": false, "isHidden": false, "orgIds": [ 0 ], "belongToAllOrgs": true, "tags": [], "type": "LOCAL_USER", "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false }, "visualization_headers": null, "stats": null }, { "metadata_id": "00000022-0000-4000-8000-000000000022", "metadata_name": "", "metadata_type": "USER_GROUP", "dependent_objects": null, "incomplete_objects": null, "metadata_detail": null, "metadata_header": { "numDefaultPinboards": 0, "numMemberUsers": 3, "id": "00000022-0000-4000-8000-000000000022", "indexVersion": 25, "generationNum": 27, "name": "", "displayName": "", "author": "00000006-0000-4000-8000-000000000006", "hasLenientDiscoverability": false, "created": 1354006445722, "modified": 1354006445987, "modifiedBy": "00000020-0000-4000-8000-000000000020", "owner": "00000022-0000-4000-8000-000000000022", "isDeleted": false, "isHidden": false, "isAutoCreated": false, "isAutoDelete": false, "orgIds": [ 0 ], "resolvedObjects": {}, "tags": [], "type": "LOCAL_GROUP", "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false }, "visualization_headers": null, "stats": null }, { "metadata_id": "00000023-0000-4000-8000-000000000023", "metadata_name": "", "metadata_type": "LOGICAL_RELATIONSHIP", "dependent_objects": null, "incomplete_objects": null, "metadata_detail": null, "metadata_header": { "id": "00000023-0000-4000-8000-000000000023", "indexVersion": 35, "generationNum": 35, "name": "", "description": "", "author": "00000006-0000-4000-8000-000000000006", "created": 1460535074875, "modified": 1504281966956, "modifiedBy": "00000006-0000-4000-8000-000000000006", "owner": "00000024-0000-4000-8000-000000000024", "isDeleted": false, "isHidden": false, "orgIds": [ 0 ], "tags": [], "type": "USER_DEFINED", "aiAnswerGenerationDisabled": false, "isExternal": false, "isDeprecated": false, "isSharedViaConnection": false }, "visualization_headers": null, "stats": null } ] } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/unparameterize": { "post": { "operationId": "unparameterizeMetadata", "description": "\nRemove parameterization from fields in metadata objects.
Version: 26.5.0.cl or later\n\nGA Version: 26.10.0.cl or later\n\nAllows removing parameterization from fields in metadata objects in ThoughtSpot.\n\nRequires appropriate permissions to modify the metadata object.\n\nThe API endpoint allows unparameterizing the following types of metadata objects:\n* Logical Tables\n* Connections\n* Connection Configs\n\nFor a Logical Table the field type must be `ATTRIBUTE` and field name can be one of:\n* databaseName\n* schemaName\n* tableName\n\nFor a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_name specifies the exact property of the Connection or Connection Config that needs to be unparameterized.\n\nFor Connection Config, the only supported field name is:\n* impersonate_user\n\n## Restored value\n\nThe endpoint has two mutually exclusive modes, and the value that is restored differs per mode:\n\n* Single-field mode (`field_name` + `value`) restores the supplied `value`.\n* Bulk mode (`metadata_entries`) ignores `value` and restores the Primary org (`org_id=0`) value of the variable bound to the field, even when the request is made from a secondary org.\n\nIn bulk mode, a secret Connection field bound to a sensitive variable is restored from the variable's Primary-org secret.\n\nBulk mode has no partial success. The request fails with `400` and nothing is changed if any field:\n* is a non-secret field bound to a sensitive variable,\n* is bound to a per-principal variable, whose value is user-specific or group-specific,\n* has a variable that cannot be read, because it is deleted or not visible to you,\n* has no Primary-org value, or\n* is a secret field whose value is unavailable from the secure store, which includes the case where the Confidant Vault is disabled, since the restored secret could then not be stored securely.\n\nSuch a field can still be unparameterized individually in single-field mode with an explicit `value`. Duplicate entries for the same object and field are coalesced.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", "26.5.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnparameterizeMetadataRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Successfuly removed parameters." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/headers/update": { "post": { "operationId": "updateMetadataHeader", "description": "\nUpdate header attributes for a given list of header objects.
Beta Version: 10.6.0.cl or later\n\n## Prerequisites\n- **Privileges Required:**\n - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer ThoughtSpot).\n- **Additional Privileges (if RBAC is enabled):**\n - `ORG_ADMINISTRATION` (Can manage orgs).\n\n---\n\n## Usage Guidelines\n\n### Parameters\n\n1. **headers_update** \n - **Description:** List of header objects with their attributes to be updated. Each object contains a list of attributes to be updated in the header.\n - **Usage:**\n - You must provide either `identifier` or `obj_identifier`, but not both. Both fields cannot be empty.\n - When `org_identifier` is set to `-1`, only the `identifier` value is accepted; `obj_identifier` is not allowed.\n\n2. **org_identifier** \n - **Description:** GUID (Globally Unique Identifier) or name of the organization. \n - **Usage:**\n - Leaving this field empty assumes that the changes should be applied to the current organization \n - Provide `org_guid` or `org_name` to uniquely identify the organization where changes need to be applied. .\n - Provide `-1` if changes have to be applied across all the org.\n\n---\n\n## Note\nCurrently, this API is enabled only for updating the `obj_identifier` attribute. Only `text` will be allowed in attribute's value.\n\n## Best Practices\n\n1. **Backup Before Conversion:** \n Always export metadata as a backup before initiating the update process\n\n---\n\n## Examples\n\n### Only `identifier` is given \n```json\n{\n \"headers_update\":\n [\n {\n \"identifier\": \"guid_1\",\n \"obj_identifier\": \"\",\n \"type\": \"LOGICAL_COLUMN\",\n \"attributes\":\n [\n {\n \"name\": \"obj_id\",\n \"value\": \"custom_object_id\"\n }\n ]\n }\n ],\n \"org_identifier\": \"orgGuid\"\n}\n```\n\n### Only `obj_identifier` is given\n```json\n{\n \"headers_update\":\n [\n {\n \"obj_identifier\": \"custom_object_id\",\n \"type\": \"ANSWER\",\n \"attributes\":\n [\n {\n \"name\": \"obj_id\",\n \"value\": \"custom_object_id\"\n }\n ]\n }\n ],\n \"org_identifier\": \"orgName\"\n}\n```\n\n### Executing update for all org `-1`\n```json\n{\n \"headers_update\":\n [\n {\n \"identifier\": \"guid_1\",\n \"type\": \"ANSWER\",\n \"attributes\":\n [\n {\n \"name\": \"obj_id\",\n \"value\": \"custom_object_id\"\n }\n ]\n }\n ],\n \"org_identifier\": -1\n}\n```\n\n### Optional `type` is not provided\n```json\n{\n \"headers_update\":\n [\n {\n \"identifier\": \"guid_1\",\n \"attributes\":\n [\n {\n \"name\": \"obj_id\",\n \"value\": \"custom_object_id\"\n }\n ]\n }\n ],\n \"org_identifier\": -1\n}\n```\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", "10.6.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMetadataHeaderRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Headers update was successful." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/metadata/update-obj-id": { "post": { "operationId": "updateMetadataObjId", "description": "\nUpdate object IDs for given metadata objects.
Beta Version: 10.8.0.cl or later\n\n## Prerequisites\n- **Privileges Required:**\n - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer ThoughtSpot).\n- **Additional Privileges (if RBAC is enabled):**\n - `ORG_ADMINISTRATION` (Can manage orgs).\n\n---\n\n## Usage Guidelines\n\n### Parameters\n\n1. **metadata** \n - **Description:** List of metadata objects to update their object IDs.\n - **Usage:**\n - Use either `current_obj_id` alone OR use `metadata_identifier` with `type` (when needed).\n - When using `metadata_identifier`, the `type` field is required if using a name instead of a GUID.\n - The `new_obj_id` field is always required.\n\n---\n\n## Note\nThis API is specifically designed for updating object IDs of metadata objects. It internally uses the header update mechanism to perform the changes.\n\n## Best Practices\n\n1. **Backup Before Update:** \n Always export metadata as a backup before initiating the update process.\n\n2. **Validation:**\n - When using `current_obj_id`, ensure it matches the existing object ID exactly.\n - When using `metadata_identifier` with a name, ensure the `type` is specified correctly.\n - Verify that the `new_obj_id` follows your naming conventions and is unique within your system.\n\n---\n\n## Examples\n\n### Using current_obj_id\n```json\n{\n \"metadata\": [\n {\n \"current_obj_id\": \"existing_object_id\",\n \"new_obj_id\": \"new_object_id\"\n }\n ]\n}\n```\n\n### Using metadata_identifier with GUID\n```json\n{\n \"metadata\": [\n {\n \"metadata_identifier\": \"01234567-89ab-cdef-0123-456789abcdef\",\n \"new_obj_id\": \"new_object_id\"\n }\n ]\n}\n```\n\n### Using metadata_identifier with name and type\n```json\n{\n \"metadata\": [\n {\n \"metadata_identifier\": \"My Answer\",\n \"type\": \"ANSWER\",\n \"new_obj_id\": \"new_object_id\"\n }\n ]\n}\n```\n\n### Multiple objects update\n```json\n{\n \"metadata\": [\n {\n \"current_obj_id\": \"existing_object_id_1\",\n \"new_obj_id\": \"new_object_id_1\"\n },\n {\n \"metadata_identifier\": \"My Worksheet\",\n \"type\": \"LOGICAL_TABLE\",\n \"new_obj_id\": \"new_object_id_2\"\n }\n ]\n}\n```\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Metadata", "10.8.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMetadataObjIdRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Headers update was successful." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/orgs/create": { "post": { "operationId": "createOrg", "description": "\n Version: 9.0.0.cl or later\n\nCreates an Org object.\n\nTo use this API, the [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview) feature must be enabled in your cluster.\n\nRequires cluster administration (**Can administer Org**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Orgs", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrgRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Organization successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgResponse" }, "examples": { "example_1": { "value": { "id": 1980035173, "name": "test_org", "status": "ACTIVE", "description": "test_org", "visibility": "SHOW" } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/orgs/{org_identifier}/delete": { "post": { "operationId": "deleteOrg", "description": "\n Version: 9.0.0.cl or later\n\nDeletes an Org object from the ThoughtSpot system.\n\nRequires cluster administration (**Can administer Org**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required.\n\nWhen you delete an Org, all its users and objects created in that Org context are removed. However, if the users in the deleted Org also exists in other Orgs, they are removed only from the deleted Org.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Orgs", "9.0.0.cl" ], "parameters": [ { "in": "path", "name": "org_identifier", "required": true, "schema": { "type": "string" }, "description": "ID or name of the Org" } ], "responses": { "204": { "description": "Organization successfully deleted." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/orgs/search": { "post": { "operationId": "searchOrgs", "description": "\n Version: 9.0.0.cl or later\n\nGets a list of Orgs configured on the ThoughtSpot system. To get details of a specific Org, specify the Org ID or name. You can also pass parameters such as status, visibility, and user identifiers to get a specific list of Orgs.\n\nResults are paginated: `record_size` (default `10`) sets the number of Orgs returned and `record_offset` (default `0`) sets the starting record. To retrieve all Orgs, increase `record_offset` by `record_size` until a page returns fewer than `record_size` Orgs.\n\nRequires cluster administration (**Can administer Org**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Orgs", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchOrgsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Organization search result.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrgResponse" } }, "examples": { "example_1": { "value": [ { "id": 0, "name": "Primary", "status": "ACTIVE", "description": "Primary Org", "visibility": "SHOW" }, { "id": 583464508, "name": "test_org", "status": "ACTIVE", "description": "test_org", "visibility": "SHOW" } ] } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/orgs/{org_identifier}/update": { "post": { "operationId": "updateOrg", "description": "\n Version: 9.0.0.cl or later\n\nUpdates an Org object. You can modify Org properties such as name, description, and user associations.\n\nRequires cluster administration (**Can administer Org**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Orgs", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrgRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "org_identifier", "required": true, "schema": { "type": "string" }, "description": "ID or name of the Org" } ], "responses": { "204": { "description": "Organization successfully updated." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/report/answer": { "post": { "operationId": "exportAnswerReport", "description": "\n Version: 9.0.0.cl or later\n\nExports an Answer in the given file format. You can download the Answer data as a PDF, PNG, CSV, or XLSX file.\n\nRequires at least view access to the Answer. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is not enabled, the `DATADOWNLOADING` (**Can download Data**) privilege is required. If RBAC is enabled, the required download privilege depends on the selected `file_format`: `CSV`, `XLSX`, and `PDF` require the `CAN_DOWNLOAD_DETAILED_DATA` (**Can download detailed data**) privilege, and `PNG` requires the `CAN_DOWNLOAD_VISUALS` (**Can download visuals**) privilege. For an Answer, the `PDF` export is a table PDF, which is why it falls under `CAN_DOWNLOAD_DETAILED_DATA` rather than `CAN_DOWNLOAD_VISUALS`.\n\n#### Usage guidelines\n\nIn the request body, specify the GUID or name of the Answer and set `file_format`. The default file format is CSV.\n\nUse the `type` parameter to specify whether the Answer being exported is a saved Answer (`SAVED`) or a pinned Answer on a Liveboard (`PINNED`). Defaults to `SAVED`. When using `PINNED`, the `metadata_identifier` must be the container id.\n\n**NOTE**:\n* The downloadable file returned in API response file is extensionless. Please rename the downloaded file by typing in the relevant extension.\n* HTML rendering is not supported for PDF exports of Answers with tables.\n\nOptionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data. \n\n\n\n#### Endpoint URL\n", "tags": [ "Reports", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportAnswerReportRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Export report file of specified metadata object is successful.", "content": { "application/octet-stream": {} } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/report/liveboard": { "post": { "operationId": "exportLiveboardReport", "description": "\n Version: 9.0.0.cl or later\n\nExports a Liveboard and its visualizations in PDF, PNG, CSV, or XLSX file format.\nThe default `file_format` is CSV.\n\nRequires at least view access to the Liveboard. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is not enabled, the `DATADOWNLOADING` (**Can download Data**) privilege is required. If RBAC is enabled, the required download privilege depends on the selected `file_format`: `CSV` and `XLSX` require the `CAN_DOWNLOAD_DETAILED_DATA` (**Can download detailed data**) privilege, and `PNG` and `PDF` require the `CAN_DOWNLOAD_VISUALS` (**Can download visuals**) privilege.\n\n#### Usage guidelines\n\nIn the request body, specify the GUID or name of the Liveboard. To generate a Liveboard report with specific visualizations, add GUIDs or names of the visualizations.\n\n**NOTE**: \n\n* The downloadable file returned in API response file is extensionless. Please rename the downloaded file by typing in the relevant extension.\n\n* Optionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data.\n\n* To include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes, including ad hoc changes to visualizations. For more information, see [Liveboard Report API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_liveboard_report_api). \n\n* Starting with ThoughtSpot Cloud 10.9.0.cl release, the Liveboard can be exported in the PNG format in the resolution of your choice. To enable this on your instance, contact ThoughtSpot support. When this feature is enabled, the options `include_cover_page`,`include_filter_page` within the `png_options` will not be available for PNG exports.\n\n* Starting with the ThoughtSpot Cloud 26.2.0.cl release,\n\n * Liveboards can be exported in CSV format. \n * All visualizations within a Liveboard can be exported as individual CSV files. \n * When exporting multiple visualizations or the entire Liveboard, the system returns the report as a compressed ZIP file containing the separate CSV files for each visualization.\n\n * Liveboards can also be exported in XLSX format. \n * All selected visualizations are consolidated into a single Excel workbook (.xlsx), with each visualization placed in its own worksheet (tab). \n * XLSX exports are limited to a maximum of 255 worksheets (tabs) per workbook.\n\n\n\n#### Endpoint URL\n", "tags": [ "Reports", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportLiveboardReportRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Export report file of specified metadata object is successful.", "content": { "application/octet-stream": {} } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/roles/create": { "post": { "operationId": "createRole", "description": "\n Version: 9.5.0.cl or later\n\nCreates a Role object in ThoughtSpot.\n\nAvailable only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To create a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Roles", "9.5.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRoleRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Role successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleResponse" } } } }, "400": { "description": "Invalid parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/roles/{role_identifier}/delete": { "post": { "operationId": "deleteRole", "description": "\n Version: 9.5.0.cl or later\n\nDeletes a Role object from the ThoughtSpot system.\n\nAvailable only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To delete a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Roles", "9.5.0.cl" ], "parameters": [ { "in": "path", "name": "role_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the Role. ReadOnly roles cannot be deleted." } ], "responses": { "204": { "description": "Role successfully deleted." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/roles/search": { "post": { "operationId": "searchRoles", "description": "\n Version: 9.5.0.cl or later\n\nGets a list of Role objects from the ThoughtSpot system.\n\nAvailable if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To search for Roles, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\nTo get details of a specific Role object, specify the GUID or name. You can also filter the API response based on user group and Org identifiers, privileges assigned to the Role, and deprecation status.\n\n**NOTE**: In addition to the GUID and name, `role_identifiers` accepts a Custom object ID if one is configured for the role. The response also includes the `obj_id` field for each role that has one set.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Roles", "9.5.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRolesRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Roles search result.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SearchRoleResponse" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/roles/{role_identifier}/update": { "post": { "operationId": "updateRole", "description": "\n Version: 9.5.0.cl or later\n\nUpdates the properties of a Role object.\n\nAvailable only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To update a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Roles", "9.5.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRoleRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "role_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the Role." } ], "responses": { "200": { "description": "Role successfully updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/schedules/create": { "post": { "operationId": "createSchedule", "description": "\nCreate schedule.
Version: 9.4.0.cl or later\n\nCreates a Liveboard schedule job.\n\nRequires at least edit access to Liveboards. To create a schedule on behalf of another user, you need `ADMINISTRATION` (**Can administer Org**) or `JOBSCHEDULING` (**Can schedule for others**) privilege and edit access to the Liveboard.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `JOBSCHEDULING` (**Can schedule for others**) privilege is required.\n\nIf RBAC is enabled, creating a schedule also requires the download privilege that corresponds to the selected `file_format`: `CSV` and `XLSX` require the `CAN_DOWNLOAD_DETAILED_DATA` (**Can download detailed data**) privilege, and `PDF` requires the `CAN_DOWNLOAD_VISUALS` (**Can download visuals**) privilege.\n\n#### Usage guidelines\n\n* The description text is mandatory. The description text appears as **Description: ** in the Liveboard schedule email notifications.\n* For Liveboards with both charts and tables, schedule creation is only supported in PDF and XLS formats. Schedules created in CSV formats for such Liveboards will fail to run. If `PDF` is set as the `file_format`, enable `pdf_options` to get the correct attachment. Not doing so may cause the attachment to be rendered empty.\n* To include only specific visualizations, specify the visualization GUIDs in the `visualization_identifiers` array.\n* You can schedule a Liveboard job to run periodically by setting frequency parameters. You can set the schedule to run daily, weekly, monthly or every n minutes or hours. The scheduled job can also be configured to run at a specific time of the day or on specific days of the week or month. Please ensure that when setting the schedule frequency for _minute of the object_, only values that are multiples of 5 are included.\n* If the `frequency` parameters are defined, you can set the time zone to a value that matches your server's time zone. For example, `US/Central`, `Etc/UTC`, `CET`. The default time zone is `America/Los_Angeles`.\n\nFor more information about Liveboard jobs, see [ThoughtSpot Product Documentation](https://docs.thoughtspot.com/cloud/latest/liveboard-schedule).\n\n\n\n#### Endpoint URL\n", "tags": [ "Schedules", "9.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateScheduleRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Schedule successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseSchedule" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/schedules/{schedule_identifier}/delete": { "post": { "operationId": "deleteSchedule", "description": "\nDeletes a scheduled job.
Version: 9.4.0.cl or later\n\nDeletes a scheduled Liveboard job.\n\nRequires at least edit access to Liveboard or `ADMINISTRATION` (**Can administer Org**) privilege. \nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `JOBSCHEDULING` (**Can schedule for others**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Schedules", "9.4.0.cl" ], "parameters": [ { "in": "path", "name": "schedule_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the scheduled job." } ], "responses": { "204": { "description": "Schedule successfully deleted." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/schedules/search": { "post": { "operationId": "searchSchedules", "description": "\nSearch Schedules
Version: 9.4.0.cl or later\n\nGets a list of scheduled jobs configured for a Liveboard.\n\nTo get details of a specific scheduled job, specify the name or GUID of the scheduled job.\n\nRequires at least view access to Liveboards.\n\n**NOTE**: When filtering schedules by parameters other than `metadata`, set `record_size` to `-1` and `record_offset` to `0` for accurate results.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Schedules", "9.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchSchedulesRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Schedule search result.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseSchedule" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/schedules/{schedule_identifier}/update": { "post": { "operationId": "updateSchedule", "description": "\nUpdate schedule.
Version: 9.4.0.cl or later\n\nUpdates a scheduled Liveboard job.\n\nRequires at least edit access to Liveboards. To update a schedule on behalf of another user, you need `ADMINISTRATION` (**Can administer Org**) or `JOBSCHEDULING` (**Can schedule for others**) privilege and edit access to the Liveboard.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `JOBSCHEDULING` (**Can schedule for others**) privilege is required.\n\nIf RBAC is enabled, changing a schedule's `file_format` also requires the download privilege that corresponds to the selected format: `CSV` and `XLSX` require the `CAN_DOWNLOAD_DETAILED_DATA` (**Can download detailed data**) privilege, and `PDF` requires the `CAN_DOWNLOAD_VISUALS` (**Can download visuals**) privilege.\n\nThe API endpoint allows you to pause a scheduled job, change the status of a paused job. You can also edit the recipients list, frequency of the job, format of the file to send to the recipients in email notifications, PDF options, and time zone setting.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Schedules", "9.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateScheduleRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "schedule_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the schedule." } ], "responses": { "204": { "description": "Schedule successfully updated." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/security/metadata/assign": { "post": { "operationId": "assignChangeAuthor", "description": "\n Version: 9.0.0.cl or later\n\nTransfers the ownership of one or several objects from one user to another.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege and edit access to the objects are required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Security", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignChangeAuthorRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Author assignment for given metadata objects is successful." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/security/column/rules/fetch": { "post": { "operationId": "fetchColumnSecurityRules", "description": "\nBeta Version: 10.12.0.cl or later\n\nFetches column security rules for specified tables.\n\nThis API endpoint retrieves column-level security rules configured for tables. It returns information about which columns are secured and which groups have access to those columns.\n\n#### Usage guidelines\n\n- Provide an array of table identifiers using either `identifier` (GUID or name) or `obj_identifier` (object ID)\n- At least one of `identifier` or `obj_identifier` must be provided for each table\n- The API returns column security rules for all specified tables\n- Users must have appropriate permissions to access security rules for the specified tables\n\n#### Required permissions\n\n- `ADMINISTRATION` - Can administer ThoughtSpot\n- `DATAMANAGEMENT` - Can manage data\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` - Can manage worksheet views and tables\n\n#### Example request\n\n```json\n{\n \"tables\": [\n {\n \"identifier\": \"table-guid\",\n \"obj_identifier\": \"table-object-id\"\n }\n ]\n}\n```\n\n#### Response format\n\nThe API returns an array of `ColumnSecurityRuleResponse` objects wrapped in a `data` field. Each `ColumnSecurityRuleResponse` object contains:\n- Table information (GUID and object ID) \n- Array of column security rules with column details, group access, and source table information\n\n#### Example response\n\n```json\n{\n \"data\": [\n {\n \"guid\": \"table-guid\",\n \"objId\": \"table-object-id\",\n \"columnSecurityRules\": [\n {\n \"column\": {\n \"id\": \"col_123\",\n \"name\": \"Salary\"\n },\n \"groups\": [\n {\n \"id\": \"group_1\",\n \"name\": \"HR Department\"\n }\n ],\n \"sourceTableDetails\": {\n \"id\": \"source-table-guid\",\n \"name\": \"Employee_Data\"\n }\n }\n ]\n }\n ]\n}\n```\n\n\n\n#### Endpoint URL\n", "tags": [ "Security", "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchColumnSecurityRulesRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Successfully fetched column security rules", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnSecurityRuleResponse" } } } } }, "400": { "description": "Bad request - Table not found or invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden - User doesn't have permission to access security rules for this table", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/security/metadata/fetch-object-privileges": { "post": { "operationId": "fetchObjectPrivileges", "description": "\n Version: 26.3.0.cl or later\n\nThis API fetches the object privileges present for the given list of principals (user or group), on the given set of objects. It supports pagination, which can be enabled and configured using the request parameters. It provides users access to certain features based on privilege based access control.\n\n#### Usage guidelines\n\n- Specify the `type` (`USER` or `USER_GROUP`) and `identifier` (either GUID or name) of the principals for which you want to retrieve object privilege information in the `principals` array.\n- Specify the `type` (`LOGICAL_TABLE`) and `identifier` (either GUID or name) of the metadata objects for which you want to retrieve object privilege information in the `metadata` array. Only `LOGICAL_TABLE` metadata type is supported for now. It may be extended for other metadata types in future.\n- To control the offset from where principals have to be fetched, use `record_offset`. When `record_offset` is 0, information is fetched from the beginning.\n- To control the number of principals to be fetched, use `record_size`. Default `record_size` is 20.\n- Ensure `record_offset` for a subsequent request is one more than the value of `record_size` of the previous request.\n- Ensure using correct Authorization Bearer Token corresponding to specific user & org. \n\n#### Example request\n\n```json\n{\n \"principals\": [\n {\n \"type\": \"type-1\",\n \"identifier\": \"principal-guid-or-name-1\"\n },\n {\n \"type\": \"type-2\",\n \"identifier\": \"principal-guid-or-name-2\"\n }\n ],\n \"metadata\": [\n {\n \"type\": \"metadata-type-1\",\n \"identifier\": \"metadata-guid-or-name-1\"\n },\n {\n \"type\": \"metadata-type-2\",\n \"identifier\": \"metadata-guid-or-name-2\"\n }\n ],\n \"record_offset\": 0,\n \"record_size\": 20\n}\n```\n\n\n#### Response format\n\nThe API returns an array of `metadata_object_privileges` objects wrapped in JSON. Each `metadata_object_privileges` object contains:\n- Metadata information (GUID, name and type)\n- Array of `principal_object_privilege_info`.\n- Each `principal_object_privilege_info` contains:\n - Principal type. All principals of this type are listed as described below.\n - Array of `principal_object_privileges`.\n - Each `principal_object_privileges` contains:\n - Principal information (GUID, name, subtype)\n - List of applied object level privileges.\n\n#### Example response\n\n```json\n{\n \"metadata_object_privileges\": [\n {\n \"metadata_id\": \"metadata-guid-1\",\n \"metadata_name\": \"metadata-name-1\",\n \"metadata_type\": \"metadata-type-1\",\n \"principal_object_privilege_info\": [\n {\n \"principal_type\": \"principal-type-1\",\n \"principal_object_privileges\": [\n {\n \"principal_id\": \"principal-guid-1\",\n \"principal_name\": \"principal-name-1\",\n \"principal_sub_type\": \"principal-sub-type-1\",\n \"object_privileges\": \"[object-privilege-1, object-privilege-2]\"\n },\n {\n \"principal_id\": \"principal-guid-2\",\n \"principal_name\": \"principal-name-2\",\n \"principal_sub_type\": \"principal-sub-type-2\",\n \"object_privileges\": \"[object-privilege-1, object-privilege-2]\"\n }\n ]\n },\n {\n \"principal_type\": \"principal-type-2\",\n \"principal_object_privileges\": [\n {\n \"principal_id\": \"principal-guid-3\",\n \"principal_name\": \"principal-guid-4\",\n \"principal_sub_type\": \"principal-sub-type-4\",\n \"object_privileges\": \"[object-privilege-1]\"\n }\n ]\n }\n ]\n },\n {\n \"metadata_id\": \"metadata-guid-2\",\n \"metadata_name\": \"metadata-name-2\",\n \"metadata_type\": \"metadata-type-2\",\n \"principal_object_privilege_info\": [\n {\n \"principal_type\": \"principal-type-1\",\n \"principal_object_privileges\": [\n {\n \"principal_id\": \"principal-guid-1\",\n \"principal_name\": \"principal-name-1\",\n \"principal_sub_type\": \"principal-sub-type-1\",\n \"object_privileges\": \"[object-privilege-3, object-privilege-4]\"\n },\n {\n \"principal_id\": \"principal-guid-2\",\n \"principal_name\": \"principal-name-2\",\n \"principal_sub_type\": \"principal-sub-type-2\",\n \"object_privileges\": \"[object-privilege-4]\"\n }\n ]\n }\n ]\n }\n ]\n}\n```\n\n\n\n#### Endpoint URL\n", "tags": [ "Security", "26.3.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchObjectPrivilegesRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Fetching defined object privileges of metadata objects is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectPrivilegesOfMetadataResponse" }, "examples": { "example": { "value": { "metadata_object_privileges": [ { "metadata_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d", "metadata_name": "Sales Model", "metadata_type": "LOGICAL_TABLE", "principal_object_privilege_info": [ { "principal_type": "USER_GROUP", "principal_object_privileges": [ { "principal_id": "7b8c9d0e-1f2a-4b3c-9d4e-5f6a7b8c9d0e", "principal_name": "", "principal_sub_type": "LOCAL_GROUP", "object_privileges": "[SPOTTER_COACHING_PRIVILEGE]" } ] }, { "principal_type": "USER", "principal_object_privileges": [ { "principal_id": "8c9d0e1f-2a3b-4c4d-8e5f-6a7b8c9d0e1f", "principal_name": "", "principal_sub_type": "LOCAL_USER", "object_privileges": "[]" } ] } ] } ] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/security/principals/fetch-permissions": { "post": { "operationId": "fetchPermissionsOfPrincipals", "description": "\n Version: 9.0.0.cl or later\n\nFetches object permission details for a given principal object such as a user and group.\n\nRequires view access to the metadata object. \n\n#### Usage guidelines\n\n* To get a list of all metadata objects that a user or group can access, specify the `type` and GUID or name of the principal.\n* To get permission details for a specific object, add the `type` and GUID or name of the metadata object to your API request.\n\nUpon successful execution, the API returns a list of metadata objects and permission details for each object. \n\n**Warning**: This API sets `record_size` to `-1` by default, which fetches all records in a single response. On ThoughtSpot instances with a large number of objects or users, this can lead to slow responses, excessive logging, and out-of-memory failures. If the object or principal count is high, set `record_size` to a smaller value and iterate through pages programmatically instead of relying on the default.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Security", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchPermissionsOfPrincipalsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Fetching permissions of principals is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionOfPrincipalsResponse" }, "examples": { "example_1": { "value": { "principal_permission_details": [ { "principal_id": "7f5e7f87-09a1-487c-a1da-c4bb35e45270", "principal_name": "test_user", "principal_type": "USER", "principal_sub_type": "LOCAL_USER", "metadata_permission_info": [ { "metadata_type": "LIVEBOARD", "metadata_permissions": [ { "metadata_id": "2ff57a24-cf90-485f-8b4b-45fc17474c6f", "metadata_name": "Learn how to use ThoughtSpot", "metadata_owner": { "id": "2ff57a24-cf90-485f-8b4b-45fc17474c6f", "name": "Learn how to use ThoughtSpot" }, "metadata_author": { "id": "59481331-ee53-42be-a548-bd87be6ddd4a", "name": "tsadmin" }, "permission": "READ_ONLY", "shared_permission": "NO_ACCESS", "group_permission": [] } ] } ] } ] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/security/metadata/fetch-permissions": { "post": { "operationId": "fetchPermissionsOnMetadata", "description": "\n Version: 9.0.0.cl or later\n\nFetches permission details for a given metadata object.\n\nRequires view access to the metadata object.\n\n#### Usage guidelines\n\n* To fetch a list of users and groups for a metadata object, specify `type` and GUID or name of the metadata object.\n* To get permission details for a specific user or group, add `type` and GUID or name of the principal object to your API request.\n\nUpon successful execution, the API returns permission details and principal information for the object specified in the API request.\n\n\n**Warning**: This API sets `record_size` to `-1` by default, which fetches all records in a single response. On ThoughtSpot instances with a large number of objects or users, this can lead to slow responses, excessive logging, and out-of-memory failures. If the object or principal count is high, set `record_size` to a smaller value and iterate through pages programmatically instead of relying on the default.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Security", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FetchPermissionsOnMetadataRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Fetching permissions of metadata objects is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionOfMetadataResponse" }, "examples": { "example_1": { "value": { "metadata_permission_details": [ { "metadata_id": "a62a5bf3-9f16-45b2-a174-7d30b3b577a9", "metadata_name": "testing", "metadata_type": "LIVEBOARD", "metadata_owner": { "id": "a62a5bf3-9f16-45b2-a174-7d30b3b577a9", "name": "testing" }, "metadata_author": { "id": "59481331-ee53-42be-a548-bd87be6ddd4a", "name": "tsadmin" }, "principal_permission_info": [ { "principal_type": "USER_GROUP", "principal_sub_type": "LOCAL_GROUP", "principal_permissions": [ { "principal_id": "d0326b56-ef23-4c8a-8327-a30e99bcc72b", "principal_name": "Administrator", "permission": "MODIFY", "shared_permission": "NO_ACCESS", "group_permission": [] } ] }, { "principal_type": "USER", "principal_sub_type": "LOCAL_USER", "principal_permissions": [ { "principal_id": "0f0dd0f7-7411-4195-a4aa-0dc6b58413c9", "principal_name": "su", "permission": "MODIFY", "shared_permission": "NO_ACCESS", "group_permission": [] }, { "principal_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "principal_name": "tsadmin", "permission": "MODIFY", "shared_permission": "NO_ACCESS", "group_permission": [] } ] } ] } ] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/security/metadata/manage-object-privilege": { "post": { "operationId": "manageObjectPrivilege", "description": "\n Version: 26.3.0.cl or later\n\nThis API allows the addition or deletion of object level privileges for a set of users and groups, on a set of metadata objects. It provides users to access certain features based on privilege based access control.\n\n#### Usage guidelines\n\n- Specify the `operation`. The supported operations are: `ADD`, `REMOVE`.\n- Specify the type of the objects on which the object privileges are being provided in `metadata_type`. Only `LOGICAL_TABLE` metadata type is supported for now. It may be extended for other metadata types in future.\n- Specify the list of object privilege types in the `object_privilege_types` array. The supported object privilege types are: `SPOTTER_COACHING_PRIVILEGE`.\n- Specify the identifiers (either GUID or name) for the metadata objects in the `metadata_identifiers` array.\n- Specify the `type` (`USER` or `USER_GROUP`) and `identifier` (either GUID or name) of the principals to which you want to apply the given operation and given object privileges in the `principals` array.\n- Ensure using correct Authorization Bearer Token corresponding to specific user & org.\n\n#### Example request\n\n```json\n{\n \"operation\": \"operation-type\",\n \"metadata_type\": \"metadata-type\",\n \"object_privilege_types\": [\"privilege-type-1\", \"privilege-type-2\"],\n \"metadata_identifiers\": [\"metadata-guid-or-name-1\", \"metadata-guid-or-name-1\"],\n \"principals\": [\n {\n \"type\": \"type-1\", \n \"identifier\": \"principal-guid-or-name-1\"\n },\n {\n \"type\": \"type-2\",\n \"identifier\": \"principal-guid-or-name-2\"\n }\n ]\n}\n```\n\n> ###### Note:\n> * Only admin users, users with edit access and users with coaching privilege on a given data-model can add or remove principals related to SPOTTER_COACHING_PRIVILEGE \n\n\n\n#### Endpoint URL\n", "tags": [ "Security", "26.3.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManageObjectPrivilegeRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Object privileges added/removed successfully" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/security/metadata/publish": { "post": { "operationId": "publishMetadata", "description": "\n Version: 26.5.0.cl or later\n\nGA Version: 26.10.0.cl or later\n\nAllows publishing metadata objects across organizations in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\n\nThe API endpoint allows publishing the following types of metadata objects:\n* Liveboards\n* Answers\n* Logical Tables\n\nThis API will essentially share the objects along with it's dependencies to\nthe org admins of the orgs to which it is being published.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Security", "26.5.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishMetadataRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Publishing metadata objects is successful." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/security/metadata/share": { "post": { "operationId": "shareMetadata", "description": "\n Version: 9.0.0.cl or later\n\nAllows sharing one or several metadata objects with users and groups in ThoughtSpot.\n\nRequires edit access to the metadata object.\n\n#### Supported metadata objects:\n* Liveboards\n* Visualizations\n* Answers\n* Models\n* Views\n* Connections\n* Collections\n\n#### Object permissions\n\nYou can provide `READ_ONLY` or `MODIFY` access when sharing an object with another user or group. The `READ_ONLY` permission grants view access to the shared object, whereas `MODIFY` provides edit access.\n\nTo prevent a user or group from accessing the shared object, specify the GUID or name of the principal and set `shareMode` to `NO_ACCESS`.\n\n#### Sharing a visualization\n\n* Sharing a visualization implicitly shares the entire Liveboard with the recipient.\n* Object permissions set for a shared visualization also apply to the Liveboard unless overridden by another API request or via UI.\n* If email notifications for object sharing are enabled, a notification with a link to the shared visualization will be sent to the recipient’s email address. Although this link opens the shared visualization, recipients can also access other visualizations in the Liveboard.\n\n#### Sharing a collection\n\nCollections support **dual permissions** that provide fine-grained control:\n\n* **Collection permissions** (`share_mode`) - controls access to the collection itself (view, edit, delete the collection)\n* **Content permissions** (`content_share_mode`) - controls access to objects within the collection (view, edit objects inside)\n\n**Default Behavior:**\n- If only `share_mode` is specified, the content permissions default to `READ_ONLY` (except when `share_mode` is `NO_ACCESS`, then content also gets `NO_ACCESS`)\n- To give users edit access to collection contents, explicitly set `content_share_mode: \"MODIFY\"`\n\n## Examples\n\nThe following JSON examples can be copy-pasted as request bodies for the REST v2 API endpoint:\n\n```bash\nPOST /callosum/v1/v2/security/metadata/share\nContent-Type: application/x-www-form-urlencoded\n```\n\n### Basic collection sharing\nShare a collection with read-only access:\n\n```json\n{\n \"metadata_type\": \"COLLECTION\",\n \"metadata_identifiers\": [\"Sales Reports Collection\"],\n \"permissions\": [{\n \"principal\": {\n \"type\": \"USER\",\n \"identifier\": \"alice@company.com\"\n },\n \"share_mode\": \"READ_ONLY\"\n }],\n \"notification\": {\n \"message\": \"I've shared the Sales Reports collection with you\",\n \"notify_on_share\": true\n }\n}\n```\n\n### Collection sharing with dual permissions\nShare a collection with different permissions for the collection vs. its contents:\n\n```json\n{\n \"metadata_type\": \"COLLECTION\",\n \"metadata_identifiers\": [\"Marketing Analytics\"],\n \"permissions\": [{\n \"principal\": {\n \"type\": \"USER\",\n \"identifier\": \"bob@company.com\"\n },\n \"share_mode\": \"MODIFY\",\n \"content_share_mode\": \"READ_ONLY\"\n }, {\n \"principal\": {\n \"type\": \"USER_GROUP\",\n \"identifier\": \"Marketing Team\"\n },\n \"share_mode\": \"READ_ONLY\",\n \"content_share_mode\": \"READ_ONLY\"\n }],\n \"notification\": {\n \"emails\": [\"bob@company.com\"],\n \"message\": \"You can edit the collection but content is read-only\",\n \"enable_custom_url\": false,\n \"notify_on_share\": true\n },\n \"has_lenient_discoverability\": false\n}\n```\n\n### Multiple collections sharing\nShare multiple collections with different users:\n\n```json\n{\n \"metadata\": [\n {\n \"type\": \"COLLECTION\",\n \"identifier\": \"Q4 Reports\"\n },\n {\n \"type\": \"COLLECTION\",\n \"identifier\": \"Executive Dashboard Collection\"\n }\n ],\n \"permissions\": [{\n \"principal\": {\n \"type\": \"USER_GROUP\",\n \"identifier\": \"Executives\"\n },\n \"share_mode\": \"MODIFY\"\n }, {\n \"principal\": {\n \"type\": \"USER\",\n \"identifier\": \"manager@company.com\"\n },\n \"share_mode\": \"READ_ONLY\",\n \"content_share_mode\": \"MODIFY\"\n }],\n \"notification\": {\n \"message\": \"Sharing quarterly collections with leadership team\",\n \"notify_on_share\": true\n }\n}\n```\n\n### Remove collection access\nRemove access to a collection by setting share_mode to NO_ACCESS:\n\n```json\n{\n \"metadata_type\": \"COLLECTION\",\n \"metadata_identifiers\": [\"Confidential Reports\"],\n \"permissions\": [{\n \"principal\": {\n \"type\": \"USER\",\n \"identifier\": \"former-employee@company.com\"\n },\n \"share_mode\": \"NO_ACCESS\"\n }],\n \"notification\": {\n \"notify_on_share\": false\n }\n}\n```\n\n### Collection Permission Scenarios\n\n**Scenario 1: Collection Admin**\n- `share_mode: MODIFY` + `content_share_mode: MODIFY` = Full control over collection and its contents\n\n**Scenario 2: Collection Curator**\n- `share_mode: MODIFY` + `content_share_mode: READ_ONLY` = Can manage collection structure but not edit contents\n\n**Scenario 3: Content Editor**\n- `share_mode: READ_ONLY` + `content_share_mode: MODIFY` = Can edit objects within collection but can't change collection itself\n\n**Scenario 4: Viewer**\n- `share_mode: READ_ONLY` + `content_share_mode: READ_ONLY` = View-only access to collection and contents\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Security", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareMetadataRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Sharing metadata objects is successful." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/security/metadata/unpublish": { "post": { "operationId": "unpublishMetadata", "description": "\n Version: 26.5.0.cl or later\n\nGA Version: 26.10.0.cl or later\n\nAllows unpublishing metadata objects from organizations in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\n\nThe API endpoint allows unpublishing the following types of metadata objects:\n* Liveboards\n* Answers\n* Logical Tables\n\nWhen unpublishing objects, you can:\n* Include dependencies by setting `include_dependencies` to true - this will unpublish all dependent objects if no other published object is using them\n* Force unpublish by setting `force` to true - this will break all dependent objects in the unpublished organizations\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Security", "26.5.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnpublishMetadataRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Unpublishing metadata objects is successful." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/security/column/rules/update": { "post": { "operationId": "updateColumnSecurityRules", "description": "\nBeta Version: 10.12.0.cl or later\n\nCreates, updates, or deletes column security rules for specified tables.\n\nThis API endpoint allows you to create, update, or delete column-level security rules on columns of a table. The operation follows an \"all or none\" policy: if defining security rules for any of the provided columns fails, the entire operation will be rolled back, and no rules will be created.\n\n#### Usage guidelines\n\n- Provide table identifier using either `identifier` (GUID or name) or `obj_identifier` (object ID)\n- Use `clear_csr: true` to remove all column security rules from the table\n- For each column, specify the security rule using `column_security_rules` array\n- Use `is_unsecured: true` to mark a specific column as unprotected\n- Use `group_access` operations to manage group associations:\n - `ADD`: Add groups to the column's access list\n - `REMOVE`: Remove groups from the column's access list\n - `REPLACE`: Replace all existing groups with the specified groups\n\n#### Required permissions\n\n- `ADMINISTRATION` - Can administer ThoughtSpot\n- `DATAMANAGEMENT` - Can manage data (if RBAC is disabled)\n- `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` - Can manage worksheet views and tables (if RBAC is enabled)\n\n#### Example request\n\n```json\n{\n \"identifier\": \"table-guid\",\n \"obj_identifier\": \"table-object-id\",\n \"clear_csr\": false,\n \"column_security_rules\": [\n {\n \"column_identifier\": \"col id or col name\",\n \"is_unsecured\": false,\n \"group_access\": [\n {\n \"operation\": \"ADD\",\n \"group_identifiers\": [\"hr_group_id\", \"hr_group_name\", \"finance_group_id\"]\n }\n ]\n },\n {\n \"column_identifier\": \"col id or col name\",\n \"is_unsecured\": true\n },\n {\n \"column_identifier\": \"col id or col name\",\n \"is_unsecured\": false,\n \"group_access\": [\n {\n \"operation\": \"REPLACE\",\n \"group_identifiers\": [\"management_group_id\", \"management_group_name\"]\n }\n ]\n }\n ]\n}\n```\n\n#### Request Body Schema\n\n- `identifier` (string, optional): GUID or name of the table for which we want to create column security rules\n- `obj_identifier` (string, optional): The object ID of the table\n- `clear_csr` (boolean, optional): If true, then all the secured columns will be marked as unprotected, and all the group associations will be removed\n- `column_security_rules` (array of objects, required): An array where each object defines the security rule for a specific column\n\nEach column security rule object contains:\n- `column_identifier` (string, required): Column identifier (col_id or name)\n- `is_unsecured` (boolean, optional): If true, the column will be marked as unprotected and all groups associated with it will be removed\n- `group_access` (array of objects, optional): Array of group operation objects\n\nEach group operation object contains:\n- `operation` (string, required): Operation type - ADD, REMOVE, or REPLACE\n- `group_identifiers` (array of strings, required): Array of group identifiers (name or GUID) on which the operation will be performed\n\n#### Response\n\nThis API does not return any response body. A successful operation returns HTTP 200 status code.\n\n#### Operation Types\n\n- **ADD**: Adds the specified groups to the column's access list\n- **REMOVE**: Removes the specified groups from the column's access list \n- **REPLACE**: Replaces all existing groups with the specified groups \n\n\n\n#### Endpoint URL\n", "tags": [ "Security", "10.12.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateColumnSecurityRulesRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Successfully updated column security rules" }, "400": { "description": "Bad request - Invalid parameters or table not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden - User doesn't have permission to modify security rules for this table", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/semantic-integrations/create": { "post": { "operationId": "createSemanticIntegration", "description": "\n Version: 26.9.0.cl or later\n\nCreates a new semantic integration in ThoughtSpot from a CDW semantic view.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- **Can manage data models**\n\n#### About create semantic integration\n\nA semantic integration imports an externally defined semantic view from a Cloud Data Warehouse (CDW) into ThoughtSpot. The API resolves the source semantic view from the specified `connection_identifier`, `database_name`, `schema_name`, and `semantic_view_name`, generates a ThoughtSpot model from it, and returns the model GUID along with a per-formula import report (`semantic_report`) summarizing how many formulas were successfully imported, failed, or skipped.\n\n- `connection_identifier`, `name`, `database_name`, `schema_name`, `semantic_view_name`, and `type` are required.\n- `name` must be unique across the user's organization. The integration's display name is also used as the generated model name.\n- Supported `type` values are listed in the `SemanticIntegrationType` enum.\n- The response includes a `semantic_report.summary` with `total`, `imported`, `failed`, and `skipped` counts, and a `formulas` array with the per-formula translation details.\n\n> **Note:** Creating a semantic integration using a YAML file upload is not supported through the public API.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Semantic Integrations", "26.9.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSemanticIntegrationRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Semantic integration created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SemanticIntegrationResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Connection not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Duplicate integration name.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/semantic-integrations/{semantic_integration_identifier}/delete": { "post": { "operationId": "deleteSemanticIntegration", "description": "\n Version: 26.9.0.cl or later\n\nDeletes a semantic integration and its associated ThoughtSpot model.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- **Can manage data models**\n\n#### About delete semantic integration\n\nRemoves the specified semantic integration and its generated ThoughtSpot model from the system.\n\n- `semantic_integration_identifier` is the GUID or name of the integration to delete.\n- Deletions cannot be undone. Re-import the integration with `createSemanticIntegration` if needed.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Semantic Integrations", "26.9.0.cl" ], "parameters": [ { "in": "path", "name": "semantic_integration_identifier", "required": true, "schema": { "type": "string" }, "description": "ID or name of the semantic integration to delete." } ], "responses": { "204": { "description": "Semantic integration deleted successfully." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/semantic-integrations/{semantic_integration_identifier}/import": { "post": { "operationId": "importSemanticIntegration", "description": "\n Version: 26.9.0.cl or later\n\nImports semantic updates for an existing semantic integration from its CDW source and refreshes the associated ThoughtSpot model.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- **Can manage data models**\n\n#### About import semantic integration\n\nRe-imports the semantic view from the CDW for the specified integration and rebuilds the corresponding ThoughtSpot model. Use this after the source semantic view has been updated in the CDW (added, removed, or modified formulas, dimensions, or measures) to bring the ThoughtSpot model back in line.\n\n- `semantic_integration_identifier` is the GUID or name of the integration to import updates for.\n- Import preserves the integration's GUID, name, and `model_id`; only the underlying formula set is refreshed.\n- The response includes the same `semantic_report` as create, with an additional `change_status` per formula indicating whether each formula is `NEW`, `UPDATED`, or `UNCHANGED` since the previous import.\n\n> **Note:** Importing updates for a semantic integration that was created using the file upload option in the ThoughtSpot UI is not supported. To refresh a file-upload-based integration, use the ThoughtSpot UI.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Semantic Integrations", "26.9.0.cl" ], "parameters": [ { "in": "path", "name": "semantic_integration_identifier", "required": true, "schema": { "type": "string" }, "description": "ID or name of the semantic integration to import updates for." } ], "responses": { "200": { "description": "Semantic integration imported successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SemanticIntegrationResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Semantic integration not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/semantic-integrations/search": { "post": { "operationId": "searchSemanticIntegrations", "description": "\n Version: 26.9.0.cl or later\n\nSearches and lists semantic integrations available to the authenticated user in the current organization, with optional filters, sort, and pagination.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required:\n\n- `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**)\n- **Can manage data models**\n\n#### About search semantic integrations\n\nReturns a paginated batch of semantic integrations, each with its identifier, name, description, source connection, generated model identifier, author, creation/modification timestamps, and associated tags. Use the filters to narrow results by author, connection, tag, or name pattern.\n\n- `pattern` matches the integration name as a case-insensitive substring.\n- `author_identifiers` and `connection_identifiers` accept either GUIDs or names.\n- `sort_options.field_name` defaults to `MODIFIED_TIME`; set `sort_options.order` to `ASC` or `DESC` to control sort direction.\n- `record_offset` and `record_size` control pagination. Use `record_size: 0` to return all matching records in a single response.\n\n**Warning**: Do not set `record_size` to `-1`. On ThoughtSpot instances with a large number of objects or users, this can lead to slow responses, excessive logging, and out-of-memory failures. Specify an explicit `record_size` and iterate through pages programmatically.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Semantic Integrations", "26.9.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchSemanticIntegrationsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Semantic integrations retrieved successfully.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SemanticIntegrationSearchResponse" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/customization/styles/fonts/delete": { "post": { "operationId": "deleteStyleFonts", "description": "\n Version: 26.7.0.cl or later\n\nDeletes one or more custom fonts from the cluster-level or org-level font library. If a deleted font is assigned to visualization areas, those assignments automatically fallback to the cluster/system default font. The response lists all affected areas where the font was explicitly set. Note: dry_run defaults to true. To actually delete fonts, you must explicitly pass dry_run: false.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege.\n\n#### Usage guidelines\n\n- Provide one or more font UUIDs or names in `font_identifiers`.\n- Set `scope` to `CLUSTER` to delete from the cluster-level library. Set `scope` to `ORG` (default) to delete from the authenticated user's org library.\n- Use `dry_run: true` to preview which visualization areas would be affected without actually deleting the font. The response lists affected assignments; no changes are applied.\n- Deletions cannot be undone. Re-upload the font file using `uploadStyleFont` if needed.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Style Customization", "26.7.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteStyleFontsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Font deleted successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StyleFontDeleteData" }, "examples": { "example_1": { "summary": "Font deleted with affected assignments", "value": { "affected_assignments": [ { "org": { "id": 1234567890, "name": "Sales" }, "visualization_areas": [ "CHART_X_AXIS_LABELS", "CHART_Y_AXIS_LABELS" ] } ] } }, "example_2": { "summary": "Font deleted with no affected assignments", "value": { "affected_assignments": [] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "Field 'font_identifiers' must contain at least one identifier." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to delete custom fonts from the font library." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Only Tenant admin can delete cluster-level fonts." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while deleting fonts from the font library." } } } } } } } } } } }, "/api/rest/2.0/customization/styles/logos/export": { "post": { "operationId": "exportStyleLogos", "description": "\n Version: 26.7.0.cl or later\n\nDownloads the active logos (default and wide slots) at the requested scope as a single ZIP archive containing both logo image files. If no custom logo has been uploaded at the ORG scope, the archive contains the resolved logo falling through from the cluster. If no cluster logo has been uploaded, no file is returned.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege.\n\n#### Usage guidelines\n\n- Set `scope` to `CLUSTER` to download cluster-level logos.\n- Set `scope` to `ORG` (default) to download logos for the authenticated user's org.\n- The response is a ZIP archive (`application/zip`). Save the response body directly to a `.zip` file.\n- The archive always contains two files — one for the DEFAULT slot and one for the WIDE slot — even if no custom logo is set at the requested scope.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Style Customization", "26.7.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportStyleLogosRequest" } } }, "required": true }, "parameters": [ { "name": "Accept", "in": "header", "schema": { "type": "string", "enum": [ "application/zip" ], "default": "application/zip" } } ], "responses": { "200": { "description": "Logo ZIP archive retrieved successfully.", "content": { "application/zip": {} } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to export style logos." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Cluster-level logos can only be exported from PRIMARY org." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while exporting style logos." } } } } } } } } } } }, "/api/rest/2.0/customization/styles/search": { "post": { "operationId": "searchStyleCustomizations", "description": "\n Version: 26.7.0.cl or later\n\nRetrieves style preferences at cluster level or for the authenticated user's org. Cluster-level preferences serve as defaults for all orgs. Org-level preferences override cluster defaults.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege.\n\n#### Usage guidelines\n\n- Set `scope` to `CLUSTER` to retrieve cluster-level style defaults.\n- Set `scope` to `ORG` (default) to retrieve preferences for the authenticated user's org.\n- Each field in the response includes an `is_overridden` flag indicating whether the value was explicitly set at the requested scope or inherited from a parent scope (cluster or system default).\n- `app_color_theme` (_available from 26.10.0.cl_) describes the same underlying color as `navigation_panel`, in a different form: `navigation_panel` uses the `DARK`/`TWO_TONE`/`CUSTOM` theme modes, while `app_color_theme` gives the brand color and how it is applied (`brand_color`, `apply_as_top_nav_color`). They never disagree, so use whichever your integration already reads. `app_color_theme` is returned only when the app color theme is enabled on the cluster; `navigation_panel` is always returned.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Style Customization", "26.7.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchStyleCustomizationsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Style preferences retrieved successfully.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StylePreference" } }, "examples": { "example_1": { "value": [ { "scope": "CLUSTER", "navigation_panel": { "theme": "DARK", "is_overridden": false }, "app_color_theme": { "brand_color": null, "apply_as_top_nav_color": false, "is_overridden": false }, "chart_color_palette": { "colors": [ { "primary": "#2359B6", "secondary": [ "#1A4690", "#0E2E66", "#07194A", "#030D30" ] }, { "primary": "#E8552D", "secondary": [ "#C4421A", "#9E2F0D", "#7A2005", "#581302" ] }, { "primary": "#F5A623", "secondary": [ "#D08B0E", "#A86E05", "#825202", "#5E3900" ] }, { "primary": "#7ED321", "secondary": [ "#62A815", "#488009", "#305A03", "#1C3800" ] }, { "primary": "#9B59B6", "secondary": [ "#7D3F9A", "#612C7E", "#481C62", "#320F48" ] }, { "primary": "#1ABC9C", "secondary": [ "#0E9E81", "#077F67", "#03624E", "#014838" ] }, { "primary": "#E74C3C", "secondary": [ "#C0392B", "#9A2518", "#761409", "#540703" ] }, { "primary": "#3498DB", "secondary": [ "#1A7DC0", "#0E60A0", "#074580", "#032C60" ] } ], "disable_color_rotation": false, "is_overridden": false }, "embedded_footer_text": { "value": "", "is_overridden": false }, "logo": { "default_logo": { "id": "a1b2c3d4-0001-0001-0001-000000000001", "is_overridden": false }, "wide_logo": { "id": "a1b2c3d4-0002-0002-0002-000000000002", "is_overridden": false } }, "visualization_fonts": { "chart_visualization_fonts": [ { "visualization_area": "CHART_X_AXIS_LABELS", "font_id": null, "font_name": null, "is_overridden": false } ], "table_visualization_fonts": [ { "visualization_area": "TABLE_VALUE_CELLS", "font_id": null, "font_name": null, "is_overridden": false } ], "advanced_chart_visualization_fonts": [ { "visualization_area": "ADVANCED_CHART_LABELS", "font_id": null, "font_name": null, "is_overridden": false } ] } }, { "scope": "ORG", "org": { "id": 1234567890, "name": "Sales" }, "navigation_panel": { "theme": "CUSTOM", "base_color": "#2359B6", "is_overridden": true }, "app_color_theme": { "brand_color": "#2359B6", "apply_as_top_nav_color": true, "is_overridden": true }, "chart_color_palette": { "colors": [ { "primary": "#2359B6", "secondary": [ "#1A4690", "#0E2E66", "#07194A", "#030D30" ] }, { "primary": "#E8552D", "secondary": [ "#C4421A", "#9E2F0D", "#7A2005", "#581302" ] }, { "primary": "#F5A623", "secondary": [ "#D08B0E", "#A86E05", "#825202", "#5E3900" ] }, { "primary": "#7ED321", "secondary": [ "#62A815", "#488009", "#305A03", "#1C3800" ] }, { "primary": "#9B59B6", "secondary": [ "#7D3F9A", "#612C7E", "#481C62", "#320F48" ] }, { "primary": "#1ABC9C", "secondary": [ "#0E9E81", "#077F67", "#03624E", "#014838" ] }, { "primary": "#E74C3C", "secondary": [ "#C0392B", "#9A2518", "#761409", "#540703" ] }, { "primary": "#3498DB", "secondary": [ "#1A7DC0", "#0E60A0", "#074580", "#032C60" ] } ], "disable_color_rotation": false, "is_overridden": false }, "embedded_footer_text": { "value": "Powered by Sales Analytics", "is_overridden": true }, "logo": { "default_logo": { "id": "b2c3d4e5-0001-0001-0001-000000000011", "is_overridden": true }, "wide_logo": { "id": "b2c3d4e5-0002-0002-0002-000000000022", "is_overridden": true } }, "visualization_fonts": { "chart_visualization_fonts": [ { "visualization_area": "CHART_X_AXIS_LABELS", "font_id": "c3d4e5f6-1111-1111-1111-111111111111", "font_name": "Acme Sans", "is_overridden": true } ], "table_visualization_fonts": [ { "visualization_area": "TABLE_VALUE_CELLS", "font_id": null, "font_name": "Optimo-Plain, Helvetica Neue, Helvetica, Arial, sans-serif", "is_overridden": false } ], "advanced_chart_visualization_fonts": [ { "visualization_area": "ADVANCED_CHART_LABELS", "font_id": "c3d4e5f6-1111-1111-1111-111111111111", "font_name": "Acme Sans", "is_overridden": true } ] } } ] } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "Field 'org_identifiers' is only allowed when scope is ORG." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to retrieve style preferences for the cluster or org." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Cluster config can only be accessed from PRIMARY org." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while retrieving style customization preferences." } } } } } } } } } } }, "/api/rest/2.0/customization/styles/fonts/search": { "post": { "operationId": "searchStyleFonts", "description": "\n Version: 26.7.0.cl or later\n\nReturns custom fonts from the cluster-level or org-level font library. Omitting all filter fields returns all fonts in the target scope.\n\nWhen `include_font_assignments` is `true`, the response includes only the visualization areas explicitly assigned to each font. For cluster-scoped fonts, `org` is returned as `null`.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege.\n\n#### Usage guidelines\n\n- Set `scope` to `CLUSTER` to search the cluster-level library. Set `scope` to `ORG` (default) to search the authenticated user's org library.\n- Use `font_identifier` to look up a specific font by UUID or name.\n- Use `name_pattern` for partial, case-insensitive name matching.\n- Set `include_font_assignments` to `true` to include visualization areas this font is currently assigned to. Defaults to `false`.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Style Customization", "26.7.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchStyleFontsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Custom fonts retrieved successfully.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StyleFontRecord" } }, "examples": { "example_1": { "value": [ { "id": "c3d4e5f6-1111-1111-1111-111111111111", "scope": "ORG", "org": { "id": 1234567890, "name": "Sales" }, "name": "Acme Sans", "weight": "NORMAL", "style": "NORMAL", "color": "#333333", "creation_time_in_millis": 1714000000000, "assignments": [ { "org": { "id": 1234567890, "name": "Sales" }, "visualization_areas": [ "CHART_X_AXIS_LABELS", "CHART_Y_AXIS_LABELS" ] } ] }, { "id": "d4e5f6a7-2222-2222-2222-222222222222", "scope": "CLUSTER", "name": "Corporate Bold", "weight": "BOLD", "style": "NORMAL", "color": "#000000", "creation_time_in_millis": 1713500000000, "assignments": [] } ] } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "Only one of 'font_identifier' or 'name_pattern' may be provided." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to search the cluster-level or org-level font library." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Cluster config can only be accessed from PRIMARY org." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while searching the font library." } } } } } } } } } } }, "/api/rest/2.0/customization/styles/update": { "post": { "operationId": "updateStyleCustomization", "description": "\n Version: 26.7.0.cl or later\n\nUpdates style preferences at cluster level or for the authenticated user's org, including navigation panel color, chart color palette, embedded footer text, logo, and font assignments per visualization area. Cluster-level preferences serve as defaults for all orgs. Org-level preferences override cluster defaults. Resetting an Org-level preference falls back to Cluster-level preference, which on reset falls back to system defaults.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege.\n\n#### Usage guidelines\n\nTwo operations are supported via the `operation` field:\n\n- **REPLACE** (default): Applies the fields provided in the request. Omitted fields remain unchanged.\n- **RESET**: Reverts specific fields to defaults. Specify which fields to reset using `reset_options.style` (for style fields) and `reset_options.visualization_areas` (for font assignments). Fields not listed in `reset_options` are not affected.\n\n#### Logo upload\n\nLogo files are uploaded as binary fields using `multipart/form-data`:\n\n- `default_logo`: Square app icon and favicon. Recommended size: 140×140 px. Accepted formats: PNG, JPG.\n- `wide_logo`: Horizontal top nav bar logo. Recommended size: 230×45 px. Accepted formats: PNG, JPG.\n\nTo reset a logo to the default, use `operation: RESET` with `reset_options.style` set to `DEFAULT_LOGO` or `WIDE_LOGO`.\n\n#### Navigation panel color\n\nSet `navigation_panel.theme` to one of:\n\n- `DARK`: Default dark theme.\n- `TWO_TONE`: Dual-tone panel style.\n- `CUSTOM`: User-defined color. Provide `navigation_panel.base_color` as a 6-digit hex string (e.g. `#2359B6`).\n\n#### App color theme\n\n`app_color_theme` (_available from 26.10.0.cl_) sets the same underlying color as `navigation_panel`, expressed as a brand color plus how it is applied. Provide exactly one of `navigation_panel` or `app_color_theme` per request; providing both returns an error. `app_color_theme` is supported only when the app color theme is enabled on the cluster; using it otherwise returns an error.\n\n- `brand_color`: Brand color as a 6-digit hex string (e.g. `#2359B6`). Omit to leave the stored color unchanged. To clear it, use `operation: RESET` with `reset_options.style` set to `APP_COLOR_THEME`.\n- `apply_as_top_nav_color`: Whether the brand color is painted on the top navigation bar literally, instead of the surface shade generated from it. Omit to leave the stored choice unchanged.\n\n`brand_color` and `apply_as_top_nav_color` may be set independently in the same request.\n\n#### Chart color palette\n\nProvide exactly 8 color entries in `chart_color_palette.colors`. Each entry requires a `primary` hex color. If `secondary` shades are omitted, the server auto-generates 4 shades from the primary color.\n\n#### Font assignments\n\nSpecify `visualization_fonts.chart_visualization_fonts`, `visualization_fonts.table_visualization_fonts`, and `visualization_fonts.advanced_chart_visualization_fonts` to assign custom fonts to specific visualization areas. Only provide the areas you want to update; omitted areas remain unchanged.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Style Customization", "26.7.0.cl" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "scope": { "description": "Scope at which to apply the preferences. CLUSTER sets cluster-level\ndefaults for all orgs. ORG applies to the authenticated user's org.", "default": "ORG", "type": "string", "enum": [ "CLUSTER", "ORG" ] }, "operation": { "description": "Operation to perform. REPLACE (default) applies the provided fields and\nleaves omitted fields unchanged. RESET reverts fields listed in\nreset_options to defaults.", "default": "REPLACE", "type": "string", "enum": [ "REPLACE", "RESET" ] }, "reset_options": { "description": "Fields to reset when operation is RESET. Specify style fields and\nvisualization areas to revert to defaults.", "allOf": [ { "$ref": "#/components/schemas/StyleResetOptionsInput" } ] }, "navigation_panel": { "description": "Navigation panel color. Provide theme and, when theme is CUSTOM, also\nprovide base_color.", "allOf": [ { "$ref": "#/components/schemas/NavigationPanelInput" } ] }, "chart_color_palette": { "description": "Chart color palette. When provided with operation REPLACE, exactly 8\ncolor entries must be specified in colors.", "allOf": [ { "$ref": "#/components/schemas/StyleColorPaletteInput" } ] }, "embedded_footer_text": { "description": "Custom footer text for the embedded application. An empty\nstring clears the footer.", "type": "string" }, "visualization_fonts": { "description": "Font assignments per visualization area. Provide only the areas to\nupdate; omitted areas remain unchanged.", "allOf": [ { "$ref": "#/components/schemas/VisualizationFontsInput" } ] }, "default_logo": { "description": "Binary image for the DEFAULT logo slot (square app icon and favicon;\nrecommended 140x140 px). Accepted formats: PNG, JPG.", "type": "string", "format": "binary" }, "wide_logo": { "description": "Binary image for the WIDE logo slot (horizontal top nav bar logo;\nrecommended 230x45 px). Accepted formats: PNG, JPG.", "type": "string", "format": "binary" } }, "required": [ "scope" ] }, "encoding": { "reset_options": { "contentType": "application/json" }, "navigation_panel": { "contentType": "application/json" }, "chart_color_palette": { "contentType": "application/json" }, "visualization_fonts": { "contentType": "application/json" } } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Style preferences updated successfully." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "chart_color_palette must specify exactly 8 color entries when operation is REPLACE." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to update style customization preferences." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Cluster-level style customization can only be updated from PRIMARY org." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while updating style customization preferences." } } } } } } } } } } }, "/api/rest/2.0/customization/styles/fonts/{font_identifier}/update": { "post": { "operationId": "updateStyleFont", "description": "\n Version: 26.7.0.cl or later\n\nUpdates the metadata of an existing custom font in the cluster-level or org-level font library. Only the fields provided in the request are modified; omitted fields remain unchanged.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege.\n\n#### Usage guidelines\n\n- Identify the font using `font_identifier` (UUID or name).\n- Set `scope` to `CLUSTER` to target the cluster-level library. Set `scope` to `ORG` (default) to target the authenticated user's org library.\n- To replace the font file itself (WOFF/WOFF2 binary), delete the existing font and re-upload using `uploadStyleFont`.\n- `color` must be a valid 6-digit hex string (e.g. `#333333`) if provided.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Style Customization", "26.7.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStyleFontRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "font_identifier", "required": true, "schema": { "type": "string" }, "description": "UUID or name of the font to update." } ], "responses": { "204": { "description": "Font metadata updated successfully." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "Font color must be a valid 6-digit hex string (e.g. '#333333')." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to update a custom font." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Only Tenant admin can update cluster-level fonts." } } } } } } } }, "500": { "description": "Unexpected error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while updating the custom font." } } } } } } } } } } }, "/api/rest/2.0/customization/styles/fonts/upload": { "post": { "operationId": "uploadStyleFont", "description": "\n Version: 26.7.0.cl or later\n\nUploads a custom font to the cluster-level or org-level font library. Cluster-level fonts are available as defaults for all orgs. Org-level fonts are only available within that org.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege.\n\n#### Usage guidelines\n\n- Only **WOFF** and **WOFF2** font formats are accepted. TTF and OTF files are rejected with an error.\n- Set `scope` to `CLUSTER` to upload to the cluster-level library. Set `scope` to `ORG` (default) to upload to the authenticated user's org library.\n- `weight` defaults to `NORMAL` if omitted. Supported values: `NORMAL`, `LIGHT`, `BOLD`.\n- `style` defaults to `NORMAL` if omitted. Supported values: `NORMAL`, `ITALIC`, `OBLIQUE`.\n- `color` defaults to `#000000` (black) if omitted. Provide as a 6-digit hex string (e.g. `#333333`).\n- The uploaded font can be assigned to visualization areas using the `updateStyleCustomization` endpoint.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Style Customization", "26.7.0.cl" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "scope": { "description": "Scope of the font library to upload to. CLUSTER uploads to the\ncluster-level library, making the font available as a default for all\norgs. ORG uploads to the authenticated user's org library. Defaults to\nORG if omitted.", "default": "ORG", "type": "string", "enum": [ "CLUSTER", "ORG" ] }, "name": { "description": "Display name for the font (e.g. \"Acme Sans\").", "type": "string" }, "weight": { "description": "Weight of the font. Supported values: NORMAL, LIGHT, BOLD. Defaults to\nNORMAL if omitted.", "default": "NORMAL", "type": "string", "enum": [ "NORMAL", "LIGHT", "BOLD" ] }, "style": { "description": "Style of the font. Supported values: NORMAL, ITALIC, OBLIQUE. Defaults\nto NORMAL if omitted.", "default": "NORMAL", "type": "string", "enum": [ "NORMAL", "ITALIC", "OBLIQUE" ] }, "color": { "description": "Color of the font as a 6-digit hex string (e.g. \"#333333\"). Defaults to\n#000000 (black) if omitted. Returns an error if the value is malformed.", "type": "string" }, "file_content": { "description": "Binary WOFF or WOFF2 font file to upload. Only WOFF and WOFF2 formats\nare accepted; TTF and OTF are rejected. The file is validated on upload.", "type": "string", "format": "binary" } }, "required": [ "name", "file_content" ] } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Font uploaded successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StyleFontUploadData" }, "examples": { "example_1": { "value": { "id": "c3d4e5f6-1111-1111-1111-111111111111", "name": "Acme Sans" } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "Unsupported font format. Only WOFF and WOFF2 are accepted." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to upload a custom font to the font library." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Cluster config can only be accessed from PRIMARY org." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while uploading the custom font." } } } } } } } } } } }, "/api/rest/2.0/system/preferences/communication-channels/configure": { "post": { "operationId": "configureCommunicationChannelPreferences", "description": "\nBeta Version: 10.14.0.cl or later\n\nConfigure communication channel preferences.\n- Use `cluster_preferences` to update the default preferences for your ThoughtSpot application instance.\n- If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), use `org_preferences` to specify Org-specific preferences that override the defaults.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "System", "10.14.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigureCommunicationChannelPreferencesRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Communication channel preferences successfully updated." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "RESET operation requires reset_events to be specified." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to configure communication channel preferences." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "ADMINISTRATION privilege required to configure cluster-level communication channel preferences." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while configuring communication channel preferences." } } } } } } } } } } }, "/api/rest/2.0/system/security-settings/configure": { "post": { "operationId": "configureSecuritySettings", "description": "\n Version: 26.2.0.cl or later\n\nConfigure security settings for your ThoughtSpot application instance.\n- Use `cluster_preferences` to update cluster-level security settings including CORS whitelisted URLs, CSP settings, SAML redirect URLs, partitioned cookies, and non-embed access configuration.\n- Use `org_preferences` to configure Org-specific security settings. If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), this allows configuring CORS and non-embed access settings specific to the Org.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. Cluster-level SAML and script-src settings require `ADMINISTRATION` privilege.\nSee [Security Settings](https://developers.thoughtspot.com/docs/security-settings) for more details.\n\n\n\n#### Endpoint URL\n", "tags": [ "System", "26.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigureSecuritySettingsRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Successfully configured the security settings." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "groups_identifiers_with_access can only be set when block_full_app_access is true." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to configure security settings." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "ADMINISTRATION privilege required to configure cluster-level security settings." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while configuring security settings." } } } } } } } } } } }, "/api/rest/2.0/system/config": { "get": { "operationId": "getSystemConfig", "description": "\n Version: 9.0.0.cl or later\n\nRetrieves the current configuration details of the cluster. If the request is successful, the API returns a list configuration settings applied on the cluster.\n\nRequires `ADMINISTRATION`(**Can administer ThoughtSpot**) privilege to view these complete configuration settings of the cluster.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `SYSTEM_INFO_ADMINISTRATION` (**Can view system activities**) privilege is required.\n\nThis API does not require any parameters to be passed in the request.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "System", "9.0.0.cl" ], "parameters": [], "responses": { "200": { "description": "Cluster config information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemConfig" }, "examples": { "example_1": { "value": { "onboarding_content_url": "", "saml_enabled": false, "okta_enabled": false } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to retrieve system configuration." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "ADMINISTRATION privilege required to retrieve system configuration." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while retrieving system configuration." } } } } } } } } } } }, "/api/rest/2.0/system": { "get": { "operationId": "getSystemInformation", "description": "\n Version: 9.0.0.cl or later\n\nGets system information such as the release version, locale, time zone, deployment environment, date format, and date time format of the cluster.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `SYSTEM_INFO_ADMINISTRATION` (**Can view system activities**) privilege is required.\n\nThis API does not require any parameters to be passed in the request. \n\n\n\n\n#### Endpoint URL\n", "tags": [ "System", "9.0.0.cl" ], "parameters": [], "responses": { "200": { "description": "Cluster information.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemInfo" }, "examples": { "example_1": { "value": { "id": "local", "name": "local", "release_version": "test", "time_zone": "America/Los_Angeles", "locale": "", "date_format": "MM/dd/yyyy", "api_version": "v1", "type": "SW", "environment": "DEV", "license": "EAE", "date_time_format": "MM/dd/yyyy h:mm a", "time_format": "HH:mm:ss", "system_user_id": "67e15c06-d153-4924-a4cd-ff615393b60f", "super_user_id": "0f0dd0f7-7411-4195-a4aa-0dc6b58413c9", "hidden_object_id": "31745bb4-defd-4e8b-8de9-8fd01db78827", "system_group_id": "179d8867-cf36-4a8d-a019-63a226fd3196", "tsadmin_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "admin_group_id": "d0326b56-ef23-4c8a-8327-a30e99bcc72b", "all_tables_connection_id": "bfc6feb4-8dac-402c-8ae8-78b43d318777", "all_user_group_id": "b25ee394-9d13-49e3-9385-cd97f5b253b4", "accept_language": "undefined", "all_user_group_member_user_count": 13, "logical_model_version": 43 } }, "example_2": { "description": "Cluster information with an upcoming maintenance window. maintenance_schedule describes the next scheduled window and is null when no maintenance is scheduled.", "value": { "id": "a1b2c3d4-5e6f-11ee-8c90-0242ac120002", "name": "my-cluster", "release_version": "26.11.0.cl-15", "time_zone": "America/Los_Angeles", "locale": "en_US", "date_format": "MM/dd/yyyy", "api_version": "v1", "type": "SAAS", "environment": "PROD", "license": "EAE", "date_time_format": "MM/dd/yyyy HH:mm:ss", "time_format": "HH:mm:ss", "system_user_id": "67e15c06-d153-4924-a4cd-ff615393b60f", "super_user_id": "0f0dd0f7-7411-4195-a4aa-0dc6b58413c9", "hidden_object_id": "31745bb4-defd-4e8b-8de9-8fd01db78827", "system_group_id": "179d8867-cf36-4a8d-a019-63a226fd3196", "tsadmin_user_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "admin_group_id": "d0326b56-ef23-4c8a-8327-a30e99bcc72b", "all_tables_connection_id": "bfc6feb4-8dac-402c-8ae8-78b43d318777", "all_user_group_id": "b25ee394-9d13-49e3-9385-cd97f5b253b4", "accept_language": "en-US,en;q=0.9", "all_user_group_member_user_count": 13, "logical_model_version": 43, "maintenance_schedule": { "start_time_in_millis": 1794722400000, "duration_in_seconds": 3600, "status": "SCHEDULED", "type": "UPGRADE", "description": "Scheduled upgrade to the next ThoughtSpot release." } } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to retrieve system information." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "ADMINISTRATION privilege required to retrieve system information." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while retrieving system information." } } } } } } } } } } }, "/api/rest/2.0/system/config-overrides": { "get": { "operationId": "getSystemOverrideInfo", "description": "\n Version: 9.2.0.cl or later\n\nGets a list of configuration overrides applied on the cluster. \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege is required.\n\nThis API does not require any parameters to be passed in the request. \n\n\n\n\n#### Endpoint URL\n", "tags": [ "System", "9.2.0.cl" ], "parameters": [], "responses": { "200": { "description": "Cluster configuration which can be overridden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemOverrideInfo" }, "examples": { "example_1": { "description": "System configuration overrides. The config_override_info field is a free-form JSON object whose keys are camelCase internal configuration property identifiers as returned by the server.", "value": { "config_override_info": { "maxTableRowsPerPage": 500, "enableCustomCalendar": true, "allowMultipleOrgs": true, "sessionTimeout": 3600 } } }, "example_2": { "description": "No configuration overrides applied", "value": { "config_override_info": {} } }, "example_3": { "description": "Configuration overrides with setting details. Each key is a configuration key; each value describes the setting (category, dataType, description) and holds its current value in current. STRING settings also return regex, and ENUM settings return the allowed values.", "value": { "config_override_info": { "batchSize": { "category": "MAIN", "dataType": "INTEGER", "description": "Data result set batch size. Data is exported in batches of batchSize upto a maximum of maxNumPaginatedRows.", "current": 1000 }, "fetchPivotSummaryFromBackend": { "category": "MAIN", "dataType": "BOOLEAN", "description": "Enable fetching Pivot Summary data from backend", "current": true }, "serpVersion": { "category": "MAIN", "dataType": "STRING", "description": "Flag to specify the SERP version (v1, v2)", "regex": ".*", "current": "v2" }, "asyncTMLConfig.importPolicy": { "category": "MAIN", "dataType": "ENUM", "description": "TML import policy to be used during async tml import.", "values": [ "PARTIAL", "ALL_OR_NONE", "VALIDATE_ONLY", "PARTIAL_OBJECT" ], "current": "PARTIAL_OBJECT" } } } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to retrieve system configuration overrides." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "ADMINISTRATION privilege required to retrieve system configuration overrides." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while retrieving system configuration overrides." } } } } } } } } } } }, "/api/rest/2.0/system/preferences/communication-channels/search": { "post": { "operationId": "searchCommunicationChannelPreferences", "description": "\nBeta Version: 10.14.0.cl or later\n\nFetch communication channel preferences.\n- Use `cluster_preferences` to fetch the default preferences for your ThoughtSpot application instance.\n- If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), use `org_preferences` to fetch any Org-specific preferences that override the defaults.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "System", "10.14.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCommunicationChannelPreferencesRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Communication channel preferences retrieved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationChannelPreferencesResponse" }, "examples": { "example_1": { "value": { "cluster_preferences": [ { "event_type": "LIVEBOARD_SCHEDULE", "channels": [ "WEBHOOK" ] } ], "org_preferences": [ { "org": { "id": "583464508", "name": "test_org" }, "preferences": [ { "event_type": "LIVEBOARD_SCHEDULE", "channels": [ "EMAIL" ] } ] } ] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "org_identifier in org_preferences does not match a known org." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to search communication channel preferences." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "ADMINISTRATION privilege required to retrieve cluster-level communication channel preferences." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while searching communication channel preferences." } } } } } } } } } } }, "/api/rest/2.0/system/security-settings/search": { "post": { "operationId": "searchSecuritySettings", "description": "\n Version: 26.2.0.cl or later\n\nFetch security settings for your ThoughtSpot application instance.\n- Use `scope: CLUSTER` to retrieve cluster-level security settings, including CORS and CSP allowlists, SAML redirect URLs, and settings that control access to non-embedded pages.\n- Use `scope: ORG` to retrieve Org-level security settings. If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), this returns CORS and non-embed access settings specific to the Org.\n- If `scope` is not specified, returns both cluster and Org-specific settings based on user privileges.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege.\nSee [Security Settings](https://developers.thoughtspot.com/docs/security-settings) for more details.\n\n\n\n#### Endpoint URL\n", "tags": [ "System", "26.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchSecuritySettingsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Successfully retrieved the list of security settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecuritySettingsResponse" }, "examples": { "example_1": { "value": { "cluster_preferences": { "enable_partitioned_cookies": false, "cors_whitelisted_urls": [ "example.com" ], "csp_settings": { "connect_src_urls": [ "https://connect.example.com" ], "font_src_urls": [ "https://font.example.com" ], "visual_embed_hosts": [ "https://embed.example.com" ], "iframe_src_urls": [ "https://embed.example.com" ], "img_src_urls": [ "https://img.example.com" ], "script_src_urls": { "enabled": true, "urls": [ "https://script.example.com" ] }, "style_src_urls": [ "https://style.example.com" ] }, "saml_redirect_urls": [ "https://saml.example.com" ], "non_embed_access": { "block_full_app_access": true } }, "org_preferences": [ { "org": { "id": 0, "name": "Primary" }, "cors_whitelisted_urls": [ "https://cors.example.com" ], "non_embed_access": { "block_full_app_access": true, "groups_with_access": [ { "id": "1234567890", "name": "Group Name" } ] } } ] } }, "example_2": { "description": "Orgs disabled. Only cluster_preferences is populated, and non_embed_access lists the groups that keep full application access while block_full_app_access is true.", "value": { "cluster_preferences": { "enable_partitioned_cookies": false, "cors_whitelisted_urls": [ "example.com" ], "csp_settings": { "connect_src_urls": [ "https://connect.example.com" ], "font_src_urls": [ "https://font.example.com" ], "visual_embed_hosts": [ "https://embed.example.com" ], "iframe_src_urls": [ "https://embed.example.com" ], "img_src_urls": [ "https://img.example.com" ], "script_src_urls": { "enabled": true, "urls": [ "https://script.example.com" ] }, "style_src_urls": [ "https://style.example.com" ] }, "saml_redirect_urls": [ "https://saml.example.com" ], "non_embed_access": { "block_full_app_access": true, "groups_with_access": [ { "id": "d0326b56-ef23-4c8a-8327-a30e99bcc72b", "name": "Administration Group" }, { "id": "7f6e5d4c-3b2a-4190-8f7e-6d5c4b3a2918", "name": "Embed Power Users" } ] }, "trusted_auth_status": "ENABLED" } } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "scope must be one of CLUSTER or ORG." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to retrieve security settings." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "ADMINISTRATION privilege required to retrieve cluster-level security settings." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while retrieving security settings." } } } } } } } } } } }, "/api/rest/2.0/system/config-update": { "post": { "operationId": "updateSystemConfig", "description": "\n Version: 9.2.0.cl or later\n\nUpdates the current configuration of the cluster. You must send the configuration data in JSON format.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "System", "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSystemConfigRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Configuration successfully updated." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "The configuration JSON contains an unknown or unsupported key." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to update system configuration." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "ADMINISTRATION privilege required to update system configuration." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while updating system configuration." } } } } } } } } } } }, "/api/rest/2.0/system/communication-channels/validate": { "post": { "operationId": "validateCommunicationChannel", "description": "\nBeta Version: 26.4.0.cl or later\n\nValidates a communication channel configuration to ensure it is properly set up and can receive events.\n- Use `channel_type` to specify the type of communication channel to validate (e.g., WEBHOOK).\n- Use `channel_identifier` to provide the unique identifier or name for the communication channel.\n- Use `event_type` to specify the event type to validate for this channel.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. For webhook channels, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "System", "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateCommunicationChannelRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "communication channel configuration validated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationChannelValidateResponse" }, "examples": { "example_1": { "description": "Successful webhook validation with HTTP check only", "value": { "channel_type": "WEBHOOK", "channel_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "channel_name": "My Liveboard Webhook", "event_type": "LIVEBOARD_SCHEDULE", "job_id": "9a8b7c6d-5e4f-3210-fedc-ba9876543210", "result_code": "SUCCESS", "details": [ { "validation_step": "HTTP_CONNECTION_CHECK", "status": "SUCCESS", "http_status": 200, "error_message": null, "aws_s3_info": null } ] } }, "example_2": { "description": "Successful webhook validation with both HTTP and S3 storage checks", "value": { "channel_type": "WEBHOOK", "channel_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "channel_name": "S3 Storage Webhook", "event_type": "LIVEBOARD_SCHEDULE", "job_id": "b2c3d4e5-f678-9012-bcde-f23456789012", "result_code": "SUCCESS", "details": [ { "validation_step": "HTTP_CONNECTION_CHECK", "status": "SUCCESS", "http_status": 200, "error_message": null, "aws_s3_info": null }, { "validation_step": "STORAGE_FILE_UPLOAD_CHECK", "status": "SUCCESS", "http_status": null, "error_message": null, "aws_s3_info": { "bucket_name": "my-webhook-files", "file_name": "thoughtspot-validation-test.json", "object_key": "webhooks/thoughtspot-validation-test.json" } } ] } }, "example_3": { "description": "Partial success: HTTP check passed but S3 upload failed", "value": { "channel_type": "WEBHOOK", "channel_id": "c3d4e5f6-7890-1234-cdef-345678901234", "channel_name": "Failed S3 Webhook", "event_type": "LIVEBOARD_SCHEDULE", "job_id": "d4e5f678-9012-3456-defa-456789012345", "result_code": "PARTIAL_SUCCESS", "details": [ { "validation_step": "HTTP_CONNECTION_CHECK", "status": "SUCCESS", "http_status": 200, "error_message": null, "aws_s3_info": null }, { "validation_step": "STORAGE_FILE_UPLOAD_CHECK", "status": "FAILED", "http_status": null, "error_message": "Access denied. Ensure the IAM role has s3:PutObject permission on the target bucket.", "aws_s3_info": null } ] } }, "example_4": { "description": "Successful webhook validation with both HTTP and GCS storage checks", "value": { "channel_type": "WEBHOOK", "channel_id": "e5f67890-1234-5678-efab-567890123456", "channel_name": "GCS Storage Webhook", "event_type": "LIVEBOARD_SCHEDULE", "job_id": "f6789012-3456-7890-fabc-678901234567", "result_code": "SUCCESS", "details": [ { "validation_step": "HTTP_CONNECTION_CHECK", "status": "SUCCESS", "http_status": 200, "error_message": null, "aws_s3_info": null }, { "validation_step": "STORAGE_FILE_UPLOAD_CHECK", "status": "SUCCESS", "http_status": null, "error_message": null, "aws_s3_info": null, "gcp_gcs_info": { "bucket_name": "my-webhook-files", "file_name": "validation_dummy_20240821_153045.pdf", "object_key": "webhooks/validation_dummy_20240821_153045.pdf" } } ] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "Webhook with the specified channel_identifier was not found." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to validate a communication channel." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Insufficient privileges to validate communication channels." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while validating the communication channel." } } } } } } } } } } }, "/api/rest/2.0/tags/assign": { "post": { "operationId": "assignTag", "description": "\n Version: 9.0.0.cl or later\n\nAssigns tags to Liveboards, Answers, Tables, and Worksheets.\n\nRequires edit access to the metadata object.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Tags", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignTagRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Tags successfully assigned." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/tags/create": { "post": { "operationId": "createTag", "description": "\n Version: 9.0.0.cl or later\n\nCreates a tag object.\n\nTags are labels that identify a metadata object. For example, you can create a tag to designate subject areas, such as sales, HR, marketing, and finance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Tags", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Tag successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tag" }, "examples": { "example_1": { "value": { "name": "test5", "id": "6abf5aec-3485-4f83-b25f-8c55b92e2b20", "color": "#342323", "deleted": false, "hidden": false, "external": false, "deprecated": false, "creation_time_in_millis": 1685441468684, "modification_time_in_millis": 1685441468684, "author_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "modifier_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "owner_id": "6abf5aec-3485-4f83-b25f-8c55b92e2b20" } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/tags/{tag_identifier}/delete": { "post": { "operationId": "deleteTag", "description": "\n Version: 9.0.0.cl or later\n\nDeletes a tag object from the ThoughtSpot system\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Tags", "9.0.0.cl" ], "parameters": [ { "in": "path", "name": "tag_identifier", "required": true, "schema": { "type": "string" }, "description": "Tag identifier Tag name or Tag id." } ], "responses": { "204": { "description": "Tag successfully deleted." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/tags/search": { "post": { "operationId": "searchTags", "description": "\n Version: 9.0.0.cl or later\n\nGets a list of tag objects available on the ThoughtSpot system. To get details of a specific tag object, specify the GUID or name.\n\nAny authenticated user can search for tag objects.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Tags", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchTagsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Tags search result.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "examples": { "example_1": { "value": [ { "name": "test4", "id": "0935bbb5-17e2-43ab-b657-da6bf347cbb4", "color": "#342323", "deleted": false, "hidden": false, "external": false, "deprecated": false, "creation_time_in_millis": 1684937524885, "modification_time_in_millis": 1684937524885, "author_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "modifier_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "owner_id": "0935bbb5-17e2-43ab-b657-da6bf347cbb4" }, { "name": "test6", "id": "65a5c39a-daf5-4cae-975f-44283628494e", "color": "#342323", "deleted": false, "hidden": false, "external": false, "deprecated": false, "creation_time_in_millis": 1684988834183, "modification_time_in_millis": 1684988887888, "author_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "modifier_id": "59481331-ee53-42be-a548-bd87be6ddd4a", "owner_id": "65a5c39a-daf5-4cae-975f-44283628494e" } ] } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/tags/unassign": { "post": { "operationId": "unassignTag", "description": "\n Version: 9.0.0.cl or later\n\nRemoves the tags applied to a Liveboard, Answer, Table, or Worksheet.\n\nRequires edit access to the metadata object.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Tags", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnassignTagRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Tags successfully unassigned." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/tags/{tag_identifier}/update": { "post": { "operationId": "updateTag", "description": "\n Version: 9.0.0.cl or later\n\nUpdates a tag object.\n\nYou can modify the `name` and `color` properties of a tag object. \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Tags", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTagRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "tag_identifier", "required": true, "schema": { "type": "string" }, "description": "Name or Id of the tag." } ], "responses": { "204": { "description": "Tag successfully updated." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/users/activate": { "post": { "operationId": "activateUser", "description": "\n Version: 9.7.0.cl or later\n\nActivates a deactivated user account.\n\nRequires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\nTo activate an inactive user account, the API request body must include the following information:\n\n- Username or the GUID of the user account.\n- Auth token generated for the deactivated user. The auth token is sent in the API response when a user is deactivated.\n- Password for the user account.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Users", "9.7.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivateUserRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "User activated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { "example": { "summary": "Previously deactivated user reactivated", "value": { "id": "c2d3e4f5-0002-4a6b-9c7d-8e9f0a1b2c3d", "name": "ops_analyst", "display_name": "Ops Analyst", "visibility": "SHARABLE", "author_id": "c2d3e4f5-0002-4a6b-9c7d-8e9f0a1b2c3d", "owner_id": "c2d3e4f5-0002-4a6b-9c7d-8e9f0a1b2c3d", "modifier_id": "c2d3e4f5-0002-4a6b-9c7d-8e9f0a1b2c3d", "tenant_id": "3c4d5e6f-7a8b-4c9d-8e0f-2a3b4c5d6e7f", "parent_type": "USER", "account_type": "LOCAL_USER", "account_status": "ACTIVE", "email": "ops.analyst@example.com", "complete_detail": true, "can_change_password": true, "current_org": { "id": 0, "name": "Primary" }, "orgs": [ { "id": 0, "name": "Primary" } ], "privileges": [ "AUTHORING", "DATADOWNLOADING" ], "user_groups": [ { "id": "7a8b9c0d-1e2f-4a3b-8c4d-6e7f8a9b0c1d", "name": "Sales" } ], "user_inherited_groups": [ { "id": "8b9c0d1e-2f3a-4b4c-9d5e-7f8a9b0c1d2e", "name": "All" } ], "home_liveboard": { "id": "4d5e6f7a-8b9c-4d0e-9f1a-3b4c5d6e7f8a", "name": "Sales Overview" }, "favorite_metadata": [ { "id": "5e6f7a8b-9c0d-4e1f-8a2b-4c5d6e7f8a9b", "name": "Quarterly Revenue", "type": "LIVEBOARD" } ], "tags": [ { "id": "6f7a8b9c-0d1e-4f2a-9b3c-5d6e7f8a9b0c", "name": "certified" } ], "group_mask": 2, "preferred_locale": "en-US", "use_browser_language": false, "notify_on_share": true, "welcome_email_sent": true, "onboarding_experience_completed": true, "show_onboarding_experience": false, "is_first_login": false, "super_user": false, "system_user": false, "external": false, "hidden": false, "deleted": false, "deprecated": false, "creation_time_in_millis": 1760198400000, "modification_time_in_millis": 1760198460000, "first_login_time_in_millis": 1760198500000, "expiration_time_in_millis": 1791734400000, "incomplete_details": [], "org_privileges": { "0": [ "AUTHORING", "DATADOWNLOADING" ] }, "extended_properties": { "displayNameLastUpdatedBy": "ADMIN" }, "extended_preferences": { "notificationChannel": "EMAIL" }, "user_parameters": { "0": { "runtime_filters": [ { "column_name": "Region", "operator": "EQ", "values": [ "East" ] } ], "parameters": [ { "name": "Discount Rate", "values": [ "0.1" ] } ] } }, "access_control_properties": { "0": { "ALL": { "filter_rules": [ { "column_name": "Region", "operator": "EQ", "values": [ "East" ] } ], "parameter_values": [ { "name": "Discount Rate", "values": [ "0.1" ] } ] }, "0e1f2a3b-4c5d-4e6f-9a7b-8c9d0e1f2a3b": { "filter_rules": [ { "column_name": "Product", "operator": "IN", "values": [ "Bags", "Shoes" ] } ] } } }, "variable_values": { "0": { "ALL": { "variable_values": [ { "name": "color", "values": [ "red" ] } ] } } } } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/users/change-password": { "post": { "operationId": "changeUserPassword", "description": "\n Version: 9.0.0.cl or later\n\nUpdates the current password of the user.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Users", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeUserPasswordRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "User password change operation successful." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/users/create": { "post": { "operationId": "createUser", "description": "\n Version: 9.0.0.cl or later\n\nCreates a user in ThoughtSpot.\n\nThe API endpoint allows you to configure several user properties such as email address, account status, share notification preferences, and sharing visibility. You can provision the user to [groups](https://docs.thoughtspot.com/cloud/latest/groups-privileges) and [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview). You can also add Liveboard, Answer, and Worksheet objects to the user’s favorites list, assign a default Liveboard for the user, and set user preferences.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Users", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "User successfully created.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { "example": { "summary": "User created in the primary org", "value": { "id": "b1c2d3e4-0001-4f5a-8b6c-7d8e9f0a1b2c", "name": "finance_analyst", "display_name": "Finance Analyst", "visibility": "SHARABLE", "author_id": "b1c2d3e4-0001-4f5a-8b6c-7d8e9f0a1b2c", "owner_id": "b1c2d3e4-0001-4f5a-8b6c-7d8e9f0a1b2c", "modifier_id": "b1c2d3e4-0001-4f5a-8b6c-7d8e9f0a1b2c", "tenant_id": "3c4d5e6f-7a8b-4c9d-8e0f-2a3b4c5d6e7f", "parent_type": "USER", "account_type": "LOCAL_USER", "account_status": "ACTIVE", "email": "finance.analyst@example.com", "complete_detail": true, "can_change_password": true, "current_org": { "id": 0, "name": "Primary" }, "orgs": [ { "id": 0, "name": "Primary" } ], "privileges": [ "AUTHORING", "DATADOWNLOADING" ], "user_groups": [ { "id": "7a8b9c0d-1e2f-4a3b-8c4d-6e7f8a9b0c1d", "name": "Sales" } ], "user_inherited_groups": [ { "id": "8b9c0d1e-2f3a-4b4c-9d5e-7f8a9b0c1d2e", "name": "All" } ], "home_liveboard": { "id": "4d5e6f7a-8b9c-4d0e-9f1a-3b4c5d6e7f8a", "name": "Sales Overview" }, "favorite_metadata": [], "tags": [ { "id": "6f7a8b9c-0d1e-4f2a-9b3c-5d6e7f8a9b0c", "name": "certified" } ], "group_mask": 2, "preferred_locale": "en-US", "use_browser_language": false, "notify_on_share": true, "welcome_email_sent": true, "onboarding_experience_completed": true, "show_onboarding_experience": false, "is_first_login": true, "super_user": false, "system_user": false, "external": false, "hidden": false, "deleted": false, "deprecated": false, "creation_time_in_millis": 1760198400000, "modification_time_in_millis": 1760198460000, "first_login_time_in_millis": 0, "expiration_time_in_millis": 1791734400000, "incomplete_details": [], "org_privileges": { "0": [ "AUTHORING", "DATADOWNLOADING" ] }, "extended_properties": { "displayNameLastUpdatedBy": "ADMIN" }, "extended_preferences": { "notificationChannel": "EMAIL" }, "user_parameters": { "0": { "runtime_filters": [ { "column_name": "Region", "operator": "EQ", "values": [ "East" ] } ], "parameters": [ { "name": "Discount Rate", "values": [ "0.1" ] } ] } }, "access_control_properties": { "0": { "ALL": { "filter_rules": [ { "column_name": "Region", "operator": "EQ", "values": [ "East" ] } ], "parameter_values": [ { "name": "Discount Rate", "values": [ "0.1" ] } ] }, "0e1f2a3b-4c5d-4e6f-9a7b-8c9d0e1f2a3b": { "filter_rules": [ { "column_name": "Product", "operator": "IN", "values": [ "Bags", "Shoes" ] } ] } } }, "variable_values": { "0": { "ALL": { "variable_values": [ { "name": "color", "values": [ "red" ] } ] } } } } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/users/deactivate": { "post": { "operationId": "deactivateUser", "description": "\n Version: 9.7.0.cl or later\n\nDeactivates a user account.\n\nRequires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\nTo deactivate a user account, the API request body must include the following information:\n\n- Username or the GUID of the user account\n- Base URL of the ThoughtSpot instance\n\nIf the API request is successful, ThoughtSpot returns the activation URL in the response. The activation URL is valid for 14 days and can be used to re-activate the account and reset the password of the deactivated account.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Users", "9.7.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeactivateUserRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "User deactivated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseActivationURL" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/users/{user_identifier}/delete": { "post": { "operationId": "deleteUser", "description": "\n Version: 9.0.0.cl or later\n\nDeletes a user from the ThoughtSpot system.\n\nIf you want to remove a user from a specific Org but not from ThoughtSpot, update the group and Org mapping properties of the user object via a POST API call to the [/api/rest/2.0/users/{user_identifier}/update](#/http/api-endpoints/users/update-user) endpoint.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Users", "9.0.0.cl" ], "parameters": [ { "in": "path", "name": "user_identifier", "required": true, "schema": { "type": "string" }, "description": "GUID / name of the user" } ], "responses": { "204": { "description": "User successfully deleted." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/users/force-logout": { "post": { "operationId": "forceLogoutUsers", "description": "\n Version: 9.0.0.cl or later\n\nEnforces logout on current user sessions. \n\nUse this API with caution as it may invalidate active user sessions and force users to re-login. Make sure you specify the usernames or GUIDs. If you pass null values in the API call, all user sessions on your cluster become invalid, and the users are forced to re-login.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Users", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForceLogoutUsersRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Force logging out of users operation successful." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/users/import": { "post": { "operationId": "importUsers", "description": "\n Version: 9.0.0.cl or later\n\nImports user data from external databases into ThoughtSpot. During the user import operation:\n\n* If the specified users are not available in ThoughtSpot, the users are created and assigned a default password. Defining a `default_password` in the API request is optional.\n* If `delete_unspecified_users` is set to `true`, the users not specified in the API request, excluding the `tsadmin`, `guest`, `system` and `su` users, are deleted.\n* If the specified user objects are already available in ThoughtSpot, the object properties are updated and synchronized as per the input data in the API request.\n\nA successful API call returns the object that represents the changes made in the ThoughtSpot system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Users", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportUsersRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Import users operation successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportUsersResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/users/reset-password": { "post": { "operationId": "resetUserPassword", "description": "\n Version: 9.0.0.cl or later\n\nResets the password of a user account. Administrators can reset password on behalf of a user.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Users", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetUserPasswordRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "User password reset operation successful." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/users/search": { "post": { "operationId": "searchUsers", "description": "\n Version: 9.0.0.cl or later\n\nGets a list of users available on the ThoughtSpot system.\n\nTo get details of a specific user, specify the user GUID or name. You can also filter the API response based on groups, Org ID, user visibility, account status, user type, and user preference settings and favorites.\n\nAvailable to all users. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view all users properties. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n**Warning**: Do not set `record_size` to `-1`. On ThoughtSpot instances with a large number of objects or users, this can lead to slow responses, excessive logging, and out-of-memory failures. Specify an explicit `record_size` and iterate through pages programmatically.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Users", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchUsersRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "User search result.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "examples": { "example": { "value": [ { "id": "9d0e1f2a-3b4c-4d5e-8f6a-7b8c9d0e1f2a", "name": "", "display_name": "", "visibility": "SHARABLE", "author_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "owner_id": "9d0e1f2a-3b4c-4d5e-8f6a-7b8c9d0e1f2a", "modifier_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e", "tenant_id": "3c4d5e6f-7a8b-4c9d-8e0f-2a3b4c5d6e7f", "parent_type": "USER", "account_type": "LOCAL_USER", "account_status": "ACTIVE", "email": "user@example.com", "complete_detail": true, "can_change_password": true, "current_org": { "id": 0, "name": "Primary" }, "orgs": [ { "id": 0, "name": "Primary" } ], "privileges": [ "AUTHORING", "DATADOWNLOADING" ], "user_groups": [ { "id": "7a8b9c0d-1e2f-4a3b-8c4d-6e7f8a9b0c1d", "name": "Sales" } ], "user_inherited_groups": [ { "id": "8b9c0d1e-2f3a-4b4c-9d5e-7f8a9b0c1d2e", "name": "All" } ], "home_liveboard": { "id": "4d5e6f7a-8b9c-4d0e-9f1a-3b4c5d6e7f8a", "name": "Sales Overview" }, "favorite_metadata": [ { "id": "5e6f7a8b-9c0d-4e1f-8a2b-4c5d6e7f8a9b", "name": "Quarterly Revenue", "type": "LIVEBOARD" } ], "tags": [ { "id": "6f7a8b9c-0d1e-4f2a-9b3c-5d6e7f8a9b0c", "name": "certified" } ], "group_mask": 2, "preferred_locale": "en-US", "use_browser_language": false, "notify_on_share": true, "welcome_email_sent": true, "onboarding_experience_completed": true, "show_onboarding_experience": false, "is_first_login": false, "super_user": false, "system_user": false, "external": false, "hidden": false, "deleted": false, "deprecated": false, "creation_time_in_millis": 1760198400000, "modification_time_in_millis": 1760198460000, "first_login_time_in_millis": 1760198500000, "expiration_time_in_millis": 1791734400000, "incomplete_details": [ "" ], "org_privileges": { "0": [ "AUTHORING", "DATADOWNLOADING" ] }, "extended_properties": { "displayNameLastUpdatedBy": "ADMIN" }, "extended_preferences": { "": "" }, "user_parameters": { "0": { "runtime_filters": [ { "column_name": "Region", "operator": "EQ", "values": [ "East" ] } ], "parameters": [ { "name": "Discount Rate", "values": [ "0.1" ] } ] } }, "access_control_properties": { "0": { "ALL": { "filter_rules": [ { "column_name": "Region", "operator": "EQ", "values": [ "East" ] } ], "parameter_values": [ { "name": "Discount Rate", "values": [ "0.1" ] } ] }, "0e1f2a3b-4c5d-4e6f-9a7b-8c9d0e1f2a3b": { "filter_rules": [ { "column_name": "Product", "operator": "IN", "values": [ "Bags", "Shoes" ] } ] } } }, "variable_values": { "0": { "ALL": { "variable_values": [ { "name": "color", "values": [ "red" ] } ] } } } } ] } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/users/{user_identifier}/update": { "post": { "operationId": "updateUser", "description": "\n Version: 9.0.0.cl or later\n\nUpdates the properties of a user object.\n\nYou can modify user properties such as username, email, and share notification settings. You can also assign new groups and Orgs, remove the user from a group or Org, reset password, and modify user preferences.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Users", "9.0.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "user_identifier", "required": true, "schema": { "type": "string" }, "description": "GUID / name of the user" } ], "responses": { "204": { "description": "User successfully updated." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/template/variables/create": { "post": { "operationId": "createVariable", "description": "\nCreate a variable which can be used for parameterizing metadata objects
Version: 26.4.0.cl or later\n\nAllows creating a variable which can be used for parameterizing metadata objects in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint supports the following types of variables:\n* CONNECTION_PROPERTY - For connection properties\n* TABLE_MAPPING - For table mappings\n* CONNECTION_PROPERTY_PER_PRINCIPAL - For connection properties per principal. In order to use this please contact support to enable this.\n* FORMULA_VARIABLE - For Formula variables, introduced in 10.15.0.cl\n\nWhen creating a variable, you need to specify:\n* The variable type\n* A unique name for the variable\n* Whether the variable contains sensitive values (defaults to false)\n* The data type of the variable, only specify for formula variables (defaults to null)\n\nThe operation will fail if:\n* The user lacks required permissions\n* The variable name already exists\n* The variable type is invalid\n\n\n\n#### Endpoint URL\n", "tags": [ "Variable", "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVariableRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Create variable is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Variable" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/template/variables/{identifier}/delete": { "post": { "operationId": "deleteVariable", "description": "\nDelete a variable
Version: 10.14.0.cl or later\n\n**Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/template/variables/delete](/api/rest/2.0/template/variables/delete) instead.\n\nAllows deleting a variable from ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint requires:\n* The variable identifier (ID or name)\n\nThe operation will fail if:\n* The user lacks required permissions\n* The variable doesn't exist\n* The variable is being used by other objects \n\n\n\n#### Endpoint URL\n", "deprecated": true, "tags": [ "Variable", "10.14.0.cl" ], "parameters": [ { "in": "path", "name": "identifier", "required": true, "schema": { "type": "string" }, "description": "Unique id, name, or object id of the variable" } ], "responses": { "204": { "description": "Deleting the variable is successful." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/template/variables/delete": { "post": { "operationId": "deleteVariables", "description": "\nDelete variable(s)
Version: 26.4.0.cl or later\n\nAllows deleting multiple variables from ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint requires:\n* The variable identifiers (IDs or names)\n\nThe operation will fail if:\n* The user lacks required permissions\n* Any of the variables don't exist\n* Any of the variables are being used by other objects\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Variable", "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteVariablesRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Deletion of variable(s) is successful." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/template/variables/{identifier}/update-values": { "post": { "operationId": "putVariableValues", "description": "\nUpdate values for a variable
Version: 26.4.0.cl or later\n\nAllows updating values for a specific variable in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows:\n* Adding new values to the variable\n* Replacing existing values\n* Deleting values from the variable\n* Resetting all values\n\nWhen updating variable values, you need to specify:\n* The variable identifier (ID or name)\n* The values to add/replace/remove\n* The operation to perform (ADD, REPLACE, REMOVE, RESET)\n\nBehaviour based on operation type:\n* ADD - Adds values to the variable if this is a list type variable, else same as replace.\n* REPLACE - Replaces all values of a given set of constraints with the current set of values.\n* REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value.\n* RESET - Removes all constraints for the given variable, scope is ignored\n\nRe-sending values that already match the stored values for the targeted scope is a no-op: the request succeeds without modifying any data. This does not apply to the RESET operation or to sensitive variables, which are always written.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Variable", "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutVariableValuesRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the variable" } ], "responses": { "204": { "description": "Variable values updated successfully." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/template/variables/search": { "post": { "operationId": "searchVariables", "description": "\nSearch variables
Version: 26.4.0.cl or later\n\nAllows searching for variables in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint supports searching variables by:\n* Variable identifier (ID or name)\n* Variable type\n* Name pattern (case-insensitive, supports % for wildcard)\n\nThe search results can be formatted in three ways:\n* METADATA - Returns only variable metadata (default)\n* METADATA_AND_VALUES - Returns variable metadata and values\n\nThe values can be filtered by scope:\n* org_identifier\n* principal_identifier\n* model_identifier\n\n\n**Warning**: Do not set `record_size` to `-1`. On ThoughtSpot instances with a large number of objects or users, this can lead to slow responses, excessive logging, and out-of-memory failures. Specify an explicit `record_size` and iterate through pages programmatically.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Variable", "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchVariablesRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "List of variables is successful.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Variable" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/template/variables/{identifier}/update": { "post": { "operationId": "updateVariable", "description": "\nUpdate a variable's name
Version: 26.4.0.cl or later\n\nAllows updating a variable's name in ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows updating:\n* The variable name\n\n\n\n#### Endpoint URL\n", "tags": [ "Variable", "26.4.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVariableRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "identifier", "required": true, "schema": { "type": "string" }, "description": "Unique id, name, or object id of the variable to update." } ], "responses": { "204": { "description": "Variable name updated successfully." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/template/variables/update-values": { "post": { "operationId": "updateVariableValues", "description": "\nUpdate values for multiple variables
Version: 10.14.0.cl or later\n\n**Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/template/variables/{identifier}/update-values](/api/rest/2.0/template/variables/%7Bidentifier%7D/update-values) instead.\n\nAllows updating values for multiple variables in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nThe API endpoint allows:\n* Adding new values to variables\n* Replacing existing values\n* Deleting values from variables\n\nWhen updating variable values, you need to specify:\n* The variable identifiers\n* The values to add/replace/remove for each variable\n* The operation to perform (ADD, REPLACE, REMOVE, RESET)\n\nBehaviour based on operation type:\n* ADD - Adds values to the variable if this is a list type variable, else same as replace.\n* REPLACE - Replaces all values of a given set of constraints with the current set of values.\n* REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value.\n* RESET - Removes all constrains for a given variable, scope is ignored\n\nRe-sending values that already match the stored values for the targeted scope is a no-op: the request succeeds without modifying any data. This does not apply to the RESET operation or to sensitive variables, which are always written.\n\n\n\n\n#### Endpoint URL\n", "deprecated": true, "tags": [ "Variable", "10.14.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVariableValuesRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Variable values updated successfully." }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/vcs/git/branches/commit": { "post": { "operationId": "commitBranch", "description": "\n Version: 9.2.0.cl or later\n\nCommits TML files of metadata objects to the Git branch configured on your instance.\n\nRequires at least edit access to objects used in the commit operation.\n\nBefore using this endpoint to push your commits:\n\n* Enable Git integration on your instance.\n* Make sure the Git repository and branch details are configured on your instance.\n\nFor more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/git-integration).\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Version Control", "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitBranchRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Successfully committed the metadata objects", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommitResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/vcs/git/config/create": { "post": { "operationId": "createConfig", "description": "\n Version: 9.2.0.cl or later\n\nAllows you to connect a ThoughtSpot instance to a Git repository.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege.\n\nYou can use this API endpoint to connect your ThoughtSpot development and production environments to the development and production branches of a Git repository.\n\nBefore using this endpoint to connect your ThoughtSpot instance to a Git repository, check the following prerequisites:\n\n* You have a Git repository. If you are using GitHub, make sure you have a valid account and an access token to connect ThoughtSpot to GitHub. For information about generating a token, see [GitHub Documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).\n\n* Your access token has `repo` scope that grants full access to public and private repositories.\n* Your Git repository has a branch that can be configured as a default branch in ThoughtSpot.\n\nFor more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/?pageid=git-integration).\n\n**Note**: ThoughtSpot supports only GitHub / itHub Enterprise for CI/CD.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Version Control", "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConfigRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Successfully configured local repository", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepoConfigObject" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/vcs/git/config/delete": { "post": { "operationId": "deleteConfig", "description": "\n Version: 9.2.0.cl or later\n\nDeletes Git repository configuration from your ThoughtSpot instance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Version Control", "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteConfigRequest" } } }, "required": true }, "parameters": [], "responses": { "204": { "description": "Successfully deleted local repository configuration" }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/vcs/git/commits/deploy": { "post": { "operationId": "deployCommit", "description": "\n Version: 9.2.0.cl or later\n\nAllows you to deploy a commit and publish TML content to your ThoughtSpot instance.\n\nRequires at least edit access to the objects used in the deploy operation.\n\nThe API deploys the head of the branch unless a `commit_id` is specified in the API request. If the branch name is not defined in the request, the default branch is considered for deploying commits.\n\nFor more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/git-integration).\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Version Control", "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeployCommitRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Successfully deployed the changes", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeployResponse" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/vcs/git/commits/{commit_id}/revert": { "post": { "operationId": "revertCommit", "description": "\n Version: 9.2.0.cl or later\n\nReverts TML objects to a previous commit specified in the API request.\n\nRequires at least edit access to objects.\n\nIn the API request, specify the `commit_id`. If the branch name is not specified in the request, the API will consider the default branch configured on your instance.\n\nBy default, the API reverts all objects. If the revert operation fails for one of the objects provided in the commit, the API returns an error and does not revert any object.\n\nFor more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/git-integration).\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Version Control", "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevertCommitRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "commit_id", "required": true, "schema": { "type": "string" }, "description": "Commit id to which the object should be reverted" } ], "responses": { "200": { "description": "Reverted the object to the commit point specified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevertResponse" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/vcs/git/commits/search": { "post": { "operationId": "searchCommits", "description": "\n Version: 9.2.0.cl or later\n\nGets a list of commits for a given metadata object.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege and edit access to the metadata objects.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Version Control", "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCommitsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Commit history of the metadata object", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommitHistoryResponse" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/vcs/git/config/search": { "post": { "operationId": "searchConfig", "description": "\n Version: 9.2.0.cl or later\n\nGets Git repository connections configured on the ThoughtSpot instance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Version Control", "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchConfigRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Details of local repository configuration", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RepoConfigObject" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/vcs/git/config/update": { "post": { "operationId": "updateConfig", "description": "\n Version: 9.2.0.cl or later\n\nUpdates Git repository configuration settings.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Version Control", "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConfigRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Successfully updated local repository configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepoConfigObject" } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/vcs/git/branches/validate": { "post": { "operationId": "validateMerge", "description": "\n Version: 9.2.0.cl or later\n\nValidates the content of your source branch against the objects in your destination environment.\n\nBefore merging content from your source branch to the destination branch, run this API operation from your destination environment and ensure that the changes from the source branch function in the destination environment.\n\nRequires `DATAMANAGEMENT` (**Can manage data**) privilege.\n\nIf [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege and edit access to the metadata objects.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Version Control", "9.2.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateMergeRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "validation done successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeployResponse" } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/rest/2.0/webhooks/create": { "post": { "operationId": "createWebhookConfiguration", "description": "\n Version: 10.14.0.cl or later\n\nCreates a new webhook configuration to receive notifications for specified events. The webhook will be triggered when the configured events occur in the system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Webhooks", "10.14.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookConfigurationRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Webhook configuration created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookResponse" }, "examples": { "example_1": { "description": "Basic webhook with Bearer token authentication", "value": { "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "name": "My Liveboard Webhook", "description": "Webhook to notify external system about liveboard schedules", "org": { "id": "0", "name": "Primary" }, "url": "https://myapp.example.com/webhooks/thoughtspot", "url_params": { "api_key": "abc123", "version": "v1" }, "events": [ "LIVEBOARD_SCHEDULE" ], "authentication": { "BEARER_TOKEN": "***" }, "signature_verification": { "type": "HMAC_SHA256", "header": "X-Webhook-Signature", "algorithm": "SHA256", "secret": "***" }, "creation_time_in_millis": 1724277430243, "modification_time_in_millis": 1724277430243, "additional_headers": [ { "key": "Custom-Header", "value": "value1" }, { "key": "Custom-Header-2", "value": "value2" } ], "created_by": { "id": "8e3f2a7b-9c4d-4e5f-8a1b-7c9d3e6f4a2b", "name": "sarah_chen" }, "last_modified_by": { "id": "8e3f2a7b-9c4d-4e5f-8a1b-7c9d3e6f4a2b", "name": "sarah_chen" } } }, "example_2": { "description": "Webhook with OAuth2 authentication", "value": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "OAuth2 Webhook", "description": "Webhook with OAuth2 client credentials", "org": { "id": "0", "name": "Primary" }, "url": "https://api.example.com/webhooks", "events": [ "LIVEBOARD_SCHEDULE" ], "authentication": { "OAUTH2": { "authorization_url": "https://auth.example.com/oauth2/authorize", "client_id": "client_123", "client_secret": "***" } }, "creation_time_in_millis": 1724278530123, "modification_time_in_millis": 1724278530123, "created_by": { "id": "7d5e9f2a-4b8c-4d6e-9a3b-5c7e1f4a8b2d", "name": "mike_rodriguez" } } }, "example_3": { "description": "Webhook with AWS S3 storage destination", "value": { "id": "e2f1a0b9-c8d7-4e6f-a5b4-3c2d1e0f9a8b", "name": "S3 Storage Webhook", "description": "Webhook that uploads payloads to an S3 bucket", "org": { "id": "0", "name": "Primary" }, "url": "https://api.example.com/webhooks", "events": [ "LIVEBOARD_SCHEDULE" ], "storage_destination": { "storage_type": "AWS_S3", "storage_config": { "aws_s3_config": { "bucket_name": "my-webhook-files", "region": "us-west-2", "role_arn": "arn:aws:iam::123456789012:role/ThoughtSpotDeliveryRole", "external_id": "ts-webhook-a1b2c3d4-7890", "path_prefix": "thoughtspot-webhooks/" } } }, "status": "DISABLED", "creation_time_in_millis": 1724279130789, "modification_time_in_millis": 1724279130789, "created_by": { "id": "5b4c3d2e-1f0a-4b9c-8d7e-6f5a4b3c2d1e", "name": "james_okafor" }, "last_modified_by": { "id": "5b4c3d2e-1f0a-4b9c-8d7e-6f5a4b3c2d1e", "name": "james_okafor" } } }, "example_4": { "description": "Webhook with GCP GCS storage destination", "value": { "id": "c9d8e7f6-a5b4-4321-9876-fedcba012345", "name": "GCS Storage Webhook", "description": "Webhook that uploads payloads to a GCS bucket", "org": { "id": "0", "name": "Primary" }, "url": "https://api.example.com/webhooks", "events": [ "LIVEBOARD_SCHEDULE" ], "storage_destination": { "storage_type": "GCP_GCS", "storage_config": { "gcp_gcs_config": { "bucket_name": "my-webhook-files", "service_account_email": "my-sa@my-project.iam.gserviceaccount.com", "path_prefix": "webhooks/" } } }, "creation_time_in_millis": 1724279630456, "modification_time_in_millis": 1724279630456, "created_by": { "id": "3a2b1c4d-5e6f-7890-abcd-ef0123456789", "name": "priya_sharma" }, "last_modified_by": { "id": "3a2b1c4d-5e6f-7890-abcd-ef0123456789", "name": "priya_sharma" } } }, "example_5": { "description": "Webhook with Basic authentication, created in DISABLED status", "value": { "id": "d3c2b1a0-9f8e-4d7c-b6a5-4f3e2d1c0b9a", "name": "Basic Auth Webhook", "description": "Webhook created disabled until the receiving endpoint is ready", "org": { "id": "0", "name": "Primary" }, "url": "https://hooks.example.com/thoughtspot", "events": [ "LIVEBOARD_SCHEDULE" ], "authentication": { "BASIC_AUTH": { "username": "webhook_user", "password": "***" } }, "status": "DISABLED", "creation_time_in_millis": 1724280730912, "modification_time_in_millis": 1724280730912, "created_by": { "id": "4c3d2e1f-0a9b-4c8d-7e6f-5a4b3c2d1e0f", "name": "lucas_moreau" }, "last_modified_by": { "id": "4c3d2e1f-0a9b-4c8d-7e6f-5a4b3c2d1e0f", "name": "lucas_moreau" } } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "At least one event type must be specified in the events field." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to create a webhook configuration." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Insufficient privileges to create webhook configurations." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while creating the webhook configuration." } } } } } } } } } } }, "/api/rest/2.0/webhooks/delete": { "post": { "operationId": "deleteWebhookConfigurations", "description": "\n Version: 10.14.0.cl or later\n\nDeletes one or more webhook configurations by their unique id or name. Returns status of each deletion operation, including successfully deleted webhooks and any failures with error details.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Webhooks", "10.14.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteWebhookConfigurationsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Webhook configurations deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDeleteResponse" }, "examples": { "example_1": { "description": "Successful deletion of multiple webhooks", "value": { "deleted_count": 2, "failed_count": 0, "deleted_webhooks": [ { "id": "b9e3d8f2-4c7a-4e1b-8d3c-5f9a2b7e4c6d", "name": "Old Webhook 1", "description": "First webhook to be deleted", "org": { "id": "0", "name": "Primary" }, "url": "https://old-service.example.com/webhook1", "events": [ "LIVEBOARD_SCHEDULE" ], "authentication": { "BEARER_TOKEN": "***" }, "creation_time_in_millis": 1724274600000, "modification_time_in_millis": 1724274600000, "created_by": { "id": "1f4e7b2d-9c3a-4e6f-8b1d-3e7c5a9b2f4e", "name": "jennifer_patel" } }, { "id": "e7c4a1f8-2b5d-4a9e-7c3f-8b1e5d4a7c9b", "name": "Old Webhook 2", "description": "Second webhook to be deleted", "org": { "id": "0", "name": "Primary" }, "url": "https://old-service.example.com/webhook2", "events": [ "LIVEBOARD_SCHEDULE" ], "authentication": { "API_KEY": { "key": "X-API-Key", "value": "***" } }, "creation_time_in_millis": 1724275530123, "modification_time_in_millis": 1724275530123, "created_by": { "id": "9a5c2e8f-4b7d-4c1e-9f2a-6c8e3b5d7a4c", "name": "david_thompson" } } ], "failed_webhooks": [] } }, "example_2": { "description": "Partial failure during deletion", "value": { "deleted_count": 1, "failed_count": 1, "deleted_webhooks": [ { "id": "c8f2a5e9-3d6b-4f1e-a8c2-7e4b1d9f5a3c", "name": "Successfully Deleted Webhook", "description": "This webhook was deleted successfully", "org": { "id": "0", "name": "Primary" }, "url": "https://service.example.com/webhook", "events": [ "LIVEBOARD_SCHEDULE" ], "authentication": { "BEARER_TOKEN": "***" }, "creation_time_in_millis": 1724276415456, "modification_time_in_millis": 1724276415456, "created_by": { "id": "6e9c4f2a-8b5d-4e1f-9c3a-5f8b2e7d4a6c", "name": "emma_wang" } } ], "failed_webhooks": [ { "id": "a3f7c1e4-9b2d-4a6e-8f3c-1e5b7a9c4f2e", "name": "Non-existent Webhook", "error": "Webhook not found or access denied" } ] } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "webhook_identifiers must contain at least one identifier." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to delete webhook configurations." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Insufficient privileges to delete webhook configurations." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while deleting webhook configurations." } } } } } } } } } } }, "/api/rest/2.0/webhooks/storage-config": { "get": { "operationId": "getWebhookStorageConfig", "description": "\n Version: 26.7.0.cl or later\n\nReturns cluster-level storage setup information for configuring customer-managed storage. Use this endpoint to obtain the IAM identity details required before configuring a webhook storage destination. For S3 destinations, returns the platform AWS account ID and IAM trust policy template. For GCS destinations, returns the platform GCP service account email and the IAM role to grant for service account impersonation.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Webhooks", "26.7.0.cl" ], "parameters": [], "responses": { "200": { "description": "Storage setup information retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookStorageConfigInfo" } }, "examples": { "example_1": { "description": "AWS-hosted cluster — customer configuring S3 storage destination", "value": [ { "storage_type": "OBJECT_STORAGE", "provider": "AWS_S3", "config": { "config_type": "AWS_TO_S3_STORAGE", "aws_account_id": "123456789012", "trust_policy_template": { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::123456789012:root" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { "sts:ExternalId": "ts-webhook-a1b2c3d4-7890" } } } ] }, "setup_instructions": [ "1. Create an IAM role in your AWS account", "2. Attach the trust policy template to the role", "3. Attach S3 permissions (s3:PutObject, s3:PutObjectAcl) to the role", "4. Use the role ARN in your webhook storage configuration" ] } } ] }, "example_2": { "description": "GCP-hosted cluster — customer configuring S3 storage destination", "value": [ { "storage_type": "OBJECT_STORAGE", "provider": "AWS_S3", "config": { "config_type": "GCP_TO_S3_STORAGE", "gcp_service_account_id": "115663769112811637952", "oidc_provider": "accounts.google.com", "trust_policy_template": { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Federated": "arn:aws:iam::YOUR_AWS_ACCOUNT_ID:oidc-provider/accounts.google.com" }, "Action": "sts:AssumeRoleWithWebIdentity", "Condition": { "StringEquals": { "accounts.google.com:sub": "115663769112811637952" } } } ] }, "setup_instructions": [ "1. Add accounts.google.com as an Identity Provider in AWS IAM", "2. Create an IAM role with Web Identity Federation trust", "3. Configure the trust policy with the GCP service account ID", "4. Attach S3 permissions (s3:PutObject, s3:PutObjectAcl) to the role", "5. Use the role ARN in your webhook storage configuration" ] } } ] }, "example_3": { "description": "GCP-hosted cluster — customer configuring both S3 and GCS storage destinations", "value": [ { "storage_type": "OBJECT_STORAGE", "provider": "AWS_S3", "config": { "config_type": "GCP_TO_S3_STORAGE", "gcp_service_account_id": "115663769112811637952", "oidc_provider": "accounts.google.com", "trust_policy_template": { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Federated": "arn:aws:iam::YOUR_AWS_ACCOUNT_ID:oidc-provider/accounts.google.com" }, "Action": "sts:AssumeRoleWithWebIdentity", "Condition": { "StringEquals": { "accounts.google.com:sub": "115663769112811637952" } } } ] }, "setup_instructions": [ "1. Add accounts.google.com as an Identity Provider in AWS IAM", "2. Create an IAM role with Web Identity Federation trust", "3. Configure the trust policy with the GCP service account ID", "4. Attach S3 permissions (s3:PutObject, s3:PutObjectAcl) to the role", "5. Use the role ARN in your webhook storage configuration" ] } }, { "storage_type": "OBJECT_STORAGE", "provider": "GCP_GCS", "config": { "config_type": "GCP_TO_GCS_STORAGE", "service_account_email": "webhook-sa@example-project.iam.gserviceaccount.com", "required_role": "roles/iam.serviceAccountTokenCreator", "setup_instructions": [ "1. In GCP Console, go to IAM & Admin > Service Accounts", "2. Click on the service account that has write access to your GCS bucket", "3. Open the 'Principals with access' tab and click 'Grant Access'", "4. Enter the service account email as the principal", "5. Assign the roles/iam.serviceAccountTokenCreator role and save", "6. Use your service account email in the webhook storage configuration" ] } } ] } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to retrieve webhook storage configuration." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Insufficient privileges to retrieve webhook storage configuration." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while retrieving webhook storage configuration." } } } } } } } } } } }, "/api/rest/2.0/webhooks/search": { "post": { "operationId": "searchWebhookConfigurations", "description": "\n Version: 10.14.0.cl or later\n\nSearches for webhook configurations based on various criteria such as Org, webhook identifier, event type, with support for pagination and sorting. Returns matching webhook configurations with their complete details.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Webhooks", "10.14.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchWebhookConfigurationsRequest" } } }, "required": true }, "parameters": [], "responses": { "200": { "description": "Webhook configurations retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSearchResponse" }, "examples": { "example_1": { "description": "Search results with multiple webhooks", "value": { "webhooks": [ { "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "name": "Liveboard Schedule Webhook", "description": "Webhook for liveboard schedule notifications", "org": { "id": "0", "name": "Primary" }, "url": "https://myapp.example.com/webhooks", "url_params": { "api_key": "abc123" }, "events": [ "LIVEBOARD_SCHEDULE" ], "authentication": { "BEARER_TOKEN": "***" }, "signature_verification": { "type": "HMAC_SHA256", "header": "X-Webhook-Signature", "algorithm": "SHA256", "secret": "***" }, "creation_time_in_millis": 1724277430243, "modification_time_in_millis": 1724278215123, "additional_headers": [ { "key": "Custom-Header", "value": "value1" }, { "key": "Custom-Header-2", "value": "value2" } ], "created_by": { "id": "8e3f2a7b-9c4d-4e5f-8a1b-7c9d3e6f4a2b", "name": "sarah_chen" }, "last_modified_by": { "id": "2c9a7e4f-6b3d-4a8e-9f1c-5e7a3b9c2d6f", "name": "alex_kim" } }, { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "API Key Webhook", "description": "Webhook with API key authentication", "org": { "id": "0", "name": "Primary" }, "url": "https://api.example.com/notifications", "events": [ "LIVEBOARD_SCHEDULE" ], "authentication": { "API_KEY": { "key": "X-API-Key", "value": "***" } }, "creation_time_in_millis": 1724275845987, "modification_time_in_millis": 1724275845987, "created_by": { "id": "7d5e9f2a-4b8c-4d6e-9a3b-5c7e1f4a8b2d", "name": "mike_rodriguez" } } ], "pagination": { "record_offset": 0, "record_size": 50, "total_count": 2, "has_more": false } } }, "example_2": { "description": "Search filtered by status, returning a webhook with S3 storage", "value": { "webhooks": [ { "id": "e2f1a0b9-c8d7-4e6f-a5b4-3c2d1e0f9a8b", "name": "S3 Storage Webhook", "org": { "id": "0", "name": "Primary" }, "url": "https://api.example.com/webhooks", "events": [ "LIVEBOARD_SCHEDULE" ], "storage_destination": { "storage_type": "AWS_S3", "storage_config": { "aws_s3_config": { "bucket_name": "my-webhook-files", "region": "us-west-2", "role_arn": "arn:aws:iam::123456789012:role/ThoughtSpotDeliveryRole", "external_id": "ts-webhook-a1b2c3d4-7890", "path_prefix": "thoughtspot-webhooks/" } } }, "status": "DISABLED", "creation_time_in_millis": 1724279130789, "modification_time_in_millis": 1724279130789, "created_by": { "id": "5b4c3d2e-1f0a-4b9c-8d7e-6f5a4b3c2d1e", "name": "james_okafor" } } ], "pagination": { "record_offset": 0, "record_size": 50, "total_count": 1, "has_more": false } } }, "example_3": { "description": "Empty search results", "value": { "webhooks": [], "pagination": { "record_offset": 0, "record_size": 50, "total_count": 0, "has_more": false } } }, "example_4": { "description": "Cross-Org search returning webhooks with OAuth2 authentication, Basic authentication, and a GCP GCS storage destination", "value": { "webhooks": [ { "id": "d3c2b1a0-9f8e-4d7c-b6a5-4f3e2d1c0b9a", "name": "Basic Auth Webhook", "description": "Webhook created disabled until the receiving endpoint is ready", "org": { "id": "1983046125", "name": "Marketing" }, "url": "https://hooks.example.com/thoughtspot", "events": [ "LIVEBOARD_SCHEDULE" ], "authentication": { "BASIC_AUTH": { "username": "webhook_user", "password": "***" } }, "status": "DISABLED", "creation_time_in_millis": 1724280730912, "modification_time_in_millis": 1724280730912, "created_by": { "id": "4c3d2e1f-0a9b-4c8d-7e6f-5a4b3c2d1e0f", "name": "lucas_moreau" } }, { "id": "c9d8e7f6-a5b4-4321-9876-fedcba012345", "name": "GCS Storage Webhook", "description": "Webhook that uploads payloads to a GCS bucket", "org": { "id": "1574427524", "name": "Sales" }, "url": "https://api.example.com/webhooks", "events": [ "LIVEBOARD_SCHEDULE" ], "storage_destination": { "storage_type": "GCP_GCS", "storage_config": { "gcp_gcs_config": { "bucket_name": "my-webhook-files", "service_account_email": "my-sa@my-project.iam.gserviceaccount.com", "path_prefix": "webhooks/" } } }, "creation_time_in_millis": 1724279630456, "modification_time_in_millis": 1724279630456, "created_by": { "id": "3a2b1c4d-5e6f-7890-abcd-ef0123456789", "name": "priya_sharma" } }, { "id": "b2c3d4e5-f6a7-4890-bcde-f23456789012", "name": "OAuth2 Webhook", "description": "Webhook with OAuth2 client credentials", "org": { "id": "0", "name": "Primary" }, "url": "https://api.example.com/webhooks", "events": [ "LIVEBOARD_SCHEDULE" ], "authentication": { "OAUTH2": { "authorization_url": "https://auth.example.com/oauth2/authorize", "client_id": "client_123", "client_secret": "***" } }, "creation_time_in_millis": 1724278530123, "modification_time_in_millis": 1724278530123, "created_by": { "id": "7d5e9f2a-4b8c-4d6e-9a3b-5c7e1f4a8b2d", "name": "mike_rodriguez" } } ], "pagination": { "record_offset": 0, "record_size": 50, "total_count": 3, "has_more": false } } } } } } }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "record_size must be a positive integer." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to search webhook configurations." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Insufficient privileges to search webhook configurations." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while searching webhook configurations." } } } } } } } } } } }, "/api/rest/2.0/webhooks/{webhook_identifier}/update": { "post": { "operationId": "updateWebhookConfiguration", "description": "\n Version: 10.14.0.cl or later\n\nUpdates an existing webhook configuration by its unique id or name. With the default `REPLACE` operation, only the provided fields are updated.\n\nUse the `RESET` operation with `reset_options` to clear an optional configuration section, such as authentication or the storage destination. A `RESET` request cannot carry any other field.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Webhooks", "10.14.0.cl" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookConfigurationRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "webhook_identifier", "required": true, "schema": { "type": "string" }, "description": "Unique ID or name of the webhook configuration." } ], "responses": { "204": { "description": "Webhook configuration updated successfully" }, "400": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "invalid_request": { "summary": "Invalid request", "value": { "error": { "message": { "code": 10002, "incident_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "trace_id_guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "debug": "Webhook with the specified identifier was not found." } } } } } } } }, "401": { "description": "Unauthorized access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unauthorized_access": { "summary": "Unauthorized access", "value": { "error": { "message": { "code": 10097, "incident_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "trace_id_guid": "b2c3d4e5-f678-9012-bcde-f23456789012", "debug": "Authentication required to update a webhook configuration." } } } } } } } }, "403": { "description": "Forbidden access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "forbidden_access": { "summary": "Forbidden access", "value": { "error": { "message": { "code": 10023, "incident_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "trace_id_guid": "c3d4e5f6-7890-1234-cdef-345678901234", "debug": "Insufficient privileges to update webhook configurations." } } } } } } } }, "500": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "unexpected_error": { "summary": "Unexpected error", "value": { "error": { "message": { "code": 10038, "incident_id_guid": "d4e5f678-9012-3456-defa-456789012345", "trace_id_guid": "d4e5f678-9012-3456-defa-456789012345", "debug": "Unexpected server error while updating the webhook configuration." } } } } } } } } } } } }, "components": { "schemas": { "ErrorResponse": { "type": "object", "properties": { "error": { "type": "object", "nullable": true } } }, "GetTokenResponse": { "type": "object", "required": [ "token", "creation_time_in_millis", "expiration_time_in_millis", "valid_for_user_id", "valid_for_username" ], "properties": { "token": { "type": "string", "description": "Bearer auth token." }, "creation_time_in_millis": { "type": "number", "format": "float", "description": "Token creation time in milliseconds." }, "expiration_time_in_millis": { "type": "number", "format": "float", "description": "Token expiration time in milliseconds." }, "valid_for_user_id": { "type": "string", "description": "Username to whom the token is issued." }, "valid_for_username": { "type": "string", "description": "Unique identifier of the user to whom the token is issued." } } }, "SearchAuthSettingsResponse": { "type": "object", "properties": { "auth_type": { "type": "string", "enum": [ "TRUSTED_AUTH" ], "description": "Type of authentication mechanism returned.", "nullable": true }, "cluster_preferences": { "$ref": "#/components/schemas/AuthClusterPreferences", "description": "Cluster-level authentication configuration. Present when cluster scope was requested and the caller has ADMINISTRATION or CONTROL_TRUSTED_AUTH privilege.", "nullable": true }, "org_preferences": { "type": "array", "items": { "$ref": "#/components/schemas/AuthOrgPreference" }, "description": "Org-level authentication configurations. Present when org scope was requested and per-org auth feature is enabled.", "nullable": true } }, "description": "Response for searchAuthSettings. Contains auth type and cluster/org-level preferences." }, "AuthClusterPreferences": { "type": "object", "properties": { "auth_status": { "type": "string", "enum": [ "ENABLED", "DISABLED" ], "description": "Whether authentication is enabled or disabled at the cluster level.", "nullable": true }, "access_tokens": { "type": "array", "items": { "$ref": "#/components/schemas/AuthSettingsAccessToken" }, "description": "Cluster-level access tokens. Absent when no token is configured.", "nullable": true } }, "description": "Cluster-level authentication preferences." }, "AuthSettingsAccessToken": { "type": "object", "required": [ "key" ], "properties": { "key": { "type": "string", "description": "The plaintext token key value." } }, "description": "An auth settings access token." }, "AuthOrgPreference": { "type": "object", "properties": { "org": { "$ref": "#/components/schemas/AuthOrgInfo", "description": "Org identifier details.", "nullable": true }, "auth_status": { "type": "string", "enum": [ "ENABLED", "DISABLED" ], "description": "Whether authentication is enabled or disabled for this org.", "nullable": true }, "access_tokens": { "type": "array", "items": { "$ref": "#/components/schemas/AuthSettingsAccessToken" }, "description": "Org-level access tokens. Absent when no token is configured or the feature flag is off.", "nullable": true } }, "description": "Org-level authentication preferences for a single org." }, "AuthOrgInfo": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32", "description": "Unique identifier of the org." }, "name": { "type": "string", "description": "Name of the org.", "nullable": true } }, "description": "Org identifier returned in auth settings search results." }, "RiseSetter": { "type": "object", "required": [ "field", "path" ], "properties": { "field": { "type": "string" }, "path": { "type": "string" } } }, "User": { "type": "object", "required": [ "id", "name", "display_name", "visibility" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the user." }, "name": { "type": "string", "description": "Name of the user." }, "display_name": { "type": "string", "description": "Display name of the user." }, "visibility": { "type": "string", "enum": [ "SHARABLE", "NON_SHARABLE" ], "description": "Visibility of the users. The `SHARABLE` property makes a user visible to other users and group, who can share objects with the user." }, "author_id": { "type": "string", "description": "Unique identifier of author of the user.", "nullable": true }, "can_change_password": { "type": "boolean", "description": "Defines whether the user can change their password.", "nullable": true }, "complete_detail": { "type": "boolean", "description": "Defines whether the response has complete detail of the user.", "nullable": true }, "creation_time_in_millis": { "type": "number", "format": "float", "description": "Creation time of the user in milliseconds.", "nullable": true }, "current_org": { "$ref": "#/components/schemas/Org", "description": "Current logged-in Org of the user.", "nullable": true }, "deleted": { "type": "boolean", "description": "Indicates whether the user is deleted.", "nullable": true }, "deprecated": { "type": "boolean", "description": "Indicates whether the user is deprecated.", "nullable": true }, "account_type": { "type": "string", "enum": [ "LOCAL_USER", "LDAP_USER", "SAML_USER", "OIDC_USER", "REMOTE_USER" ], "description": "Type of the user account.", "nullable": true }, "account_status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE", "EXPIRED", "LOCKED", "PENDING", "SUSPENDED" ], "description": "Status of the user account.", "nullable": true }, "email": { "type": "string", "description": "Email of the user.", "nullable": true }, "expiration_time_in_millis": { "type": "number", "format": "float", "description": "Expiration time of the user in milliseconds.", "nullable": true }, "external": { "type": "boolean", "description": "Indicates whether the user is external.", "nullable": true }, "favorite_metadata": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteMetadataItem" }, "description": "Metadata objects to add to the users' favorites list.", "nullable": true }, "first_login_time_in_millis": { "type": "number", "format": "float", "description": "Timestamp of the first login session of the user in milliseconds.", "nullable": true }, "group_mask": { "type": "integer", "format": "int32", "description": "Group mask of the user.", "nullable": true }, "hidden": { "type": "boolean", "description": "Indicates whether the user is hidden.", "nullable": true }, "home_liveboard": { "$ref": "#/components/schemas/Object_ID_And_Name", "description": "Unique ID or name of the default Liveboard assigned to the user.", "nullable": true }, "incomplete_details": { "type": "object", "description": "Incomplete details of user if any present.", "nullable": true }, "is_first_login": { "type": "boolean", "description": "Indicates whether it is first login of the user.", "nullable": true }, "modification_time_in_millis": { "type": "number", "format": "float", "description": "Last modified time of the user in milliseconds.", "nullable": true }, "modifier_id": { "type": "string", "description": "Unique identifier of modifier of the user.", "nullable": true }, "notify_on_share": { "type": "boolean", "description": "User preference for receiving email notifications on shared Answers or Liveboard.", "nullable": true }, "onboarding_experience_completed": { "type": "boolean", "description": "The user preference for turning off the onboarding experience.", "nullable": true }, "orgs": { "type": "array", "items": { "$ref": "#/components/schemas/Org" }, "description": "Orgs to which the user belongs.", "nullable": true }, "owner_id": { "type": "string", "description": "Unique identifier of owner of the user.", "nullable": true }, "parent_type": { "type": "string", "enum": [ "USER", "GROUP" ], "description": "Parent type of the user.", "nullable": true }, "privileges": { "type": "array", "items": { "type": "string" }, "description": "Privileges which are assigned to the user.", "nullable": true }, "show_onboarding_experience": { "type": "boolean", "description": "User's preference to revisit the new user onboarding experience.", "nullable": true }, "super_user": { "type": "boolean", "description": "Indicates whether the user is a super user.", "nullable": true }, "system_user": { "type": "boolean", "description": "Indicates whether the user is a system user.", "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Object_ID_And_Name" }, "description": "Tags associated with the user.", "nullable": true }, "tenant_id": { "type": "string", "description": "Unique identifier of tenant of the user.", "nullable": true }, "user_groups": { "type": "array", "items": { "$ref": "#/components/schemas/Object_ID_And_Name" }, "description": "Groups to which the user is assigned.", "nullable": true }, "user_inherited_groups": { "type": "array", "items": { "$ref": "#/components/schemas/Object_ID_And_Name" }, "description": "Inherited User Groups which the user is part of.", "nullable": true }, "welcome_email_sent": { "type": "boolean", "description": "Indicates whether welcome email is sent for the user.", "nullable": true }, "org_privileges": { "type": "object", "description": "Privileges which are assigned to the user with org.", "nullable": true }, "preferred_locale": { "type": "string", "description": "Locale for the user.", "nullable": true }, "use_browser_language": { "type": "boolean", "description": "Flag to indicate whether to use the browser locale for the user in the UI.\nWhen set to true, the preferred_locale value is unset and the browser's\nlanguage setting takes precedence.
Version: 26.3.0.cl or later", "nullable": true }, "extended_properties": { "type": "object", "description": "Properties for the user", "nullable": true }, "extended_preferences": { "type": "object", "description": "Preferences for the user", "nullable": true }, "user_parameters": { "type": "object", "description": "User Parameters which are specified for the user via JWToken", "nullable": true }, "access_control_properties": { "type": "object", "description": "Access Control Properties which are specified for the user via JWToken", "nullable": true }, "variable_values": { "type": "object", "description": "Formula Variables which are specified for the user via JWToken", "nullable": true } } }, "Org": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int32", "description": "The ID of the object." }, "name": { "type": "string", "description": "Name of the object." } }, "description": "The current Org context of the user." }, "FavoriteMetadataItem": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "type": "string", "description": "Unique ID of the metadata object." }, "name": { "type": "string", "description": "name of the metadata object." }, "type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "LOGICAL_COLUMN", "CONNECTION", "TAG", "USER", "USER_GROUP", "LOGICAL_RELATIONSHIP" ], "description": " Type of metadata object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier." } } }, "Object_ID_And_Name": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the object.", "nullable": true }, "name": { "type": "string", "description": "Name of the object.", "nullable": true } }, "description": "The object representation with ID and Name." }, "FavoriteMetadataInput": { "type": "object", "properties": { "identifier": { "type": "string", "description": "Unique ID or name of the metadata object.", "nullable": true }, "type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER" ], "description": " Type of metadata object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.", "nullable": true } } }, "SortOptions": { "type": "object", "properties": { "field_name": { "type": "string", "enum": [ "NAME", "DISPLAY_NAME", "AUTHOR", "CREATED", "MODIFIED" ], "description": "Name of the field to apply the sort on.", "nullable": true }, "order": { "type": "string", "enum": [ "ASC", "DESC" ], "description": "Sort order : ASC(Ascending) or DESC(Descending).", "nullable": true } }, "description": "Sort options." }, "SystemInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the object", "nullable": true }, "name": { "type": "string", "description": "Name of the cluster.", "nullable": true }, "release_version": { "type": "string", "description": "The release version of the cluster.", "nullable": true }, "time_zone": { "type": "string", "description": "The timezone of the cluster.", "nullable": true }, "locale": { "type": "string", "description": "The default locale of the cluster.", "nullable": true }, "date_format": { "type": "string", "description": "The default date format representation of the cluster.", "nullable": true }, "api_version": { "type": "string", "description": "The API version of the cluster.", "nullable": true }, "type": { "type": "string", "description": "The deployment type of the cluster.", "nullable": true }, "environment": { "type": "string", "description": "The deployed environment of the cluster.", "nullable": true }, "license": { "type": "string", "description": "The license applied to the cluster.", "nullable": true }, "date_time_format": { "type": "string", "description": "The default date time format representation of the cluster.", "nullable": true }, "time_format": { "type": "string", "description": "The default time format representation of the cluster.", "nullable": true }, "system_user_id": { "type": "string", "description": "The unique identifier of system user.", "nullable": true }, "super_user_id": { "type": "string", "description": "The unique identifier of super user.", "nullable": true }, "hidden_object_id": { "type": "string", "description": "The unique identifier of hidden object.", "nullable": true }, "system_group_id": { "type": "string", "description": "The unique identifier of system group.", "nullable": true }, "tsadmin_user_id": { "type": "string", "description": "The unique identifier of tsadmin user.", "nullable": true }, "admin_group_id": { "type": "string", "description": "The unique identifier of admin group.", "nullable": true }, "all_tables_connection_id": { "type": "string", "description": "The unique identifier of all tables connection.", "nullable": true }, "all_user_group_id": { "type": "string", "description": "The unique identifier of ALL group.", "nullable": true }, "accept_language": { "type": "string", "description": "The supported accept language by the cluster.", "nullable": true }, "all_user_group_member_user_count": { "type": "integer", "format": "int32", "description": "The count of users of ALL group.", "nullable": true }, "logical_model_version": { "type": "integer", "format": "int32", "description": "The version number of logical model of the cluster.", "nullable": true } } }, "SystemConfig": { "type": "object", "properties": { "onboarding_content_url": { "type": "string", "nullable": true }, "saml_enabled": { "type": "boolean", "nullable": true }, "okta_enabled": { "type": "boolean", "nullable": true } } }, "SystemOverrideInfo": { "type": "object", "properties": { "config_override_info": { "type": "object", "nullable": true } } }, "OrgPreferenceSearchCriteriaInput": { "type": "object", "required": [ "org_identifier" ], "properties": { "org_identifier": { "type": "string", "description": "Unique identifier or name of the org" }, "event_types": { "type": "array", "items": { "type": "string", "enum": [ "LIVEBOARD_SCHEDULE" ] }, "description": "Event types to search for. If not provided, all event types for this org are returned.", "nullable": true } } }, "CommunicationChannelPreferencesResponse": { "type": "object", "properties": { "cluster_preferences": { "type": "array", "items": { "$ref": "#/components/schemas/EventChannelConfig" }, "description": "Cluster-level default configurations.", "nullable": true }, "org_preferences": { "type": "array", "items": { "$ref": "#/components/schemas/OrgChannelConfigResponse" }, "description": "Org-specific configurations.", "nullable": true } } }, "EventChannelConfig": { "type": "object", "required": [ "event_type", "channels" ], "properties": { "event_type": { "type": "string", "enum": [ "LIVEBOARD_SCHEDULE" ], "description": "Type of event for which communication channels are configured" }, "channels": { "type": "array", "items": { "type": "string", "enum": [ "EMAIL", "WEBHOOK" ] }, "description": "Communication channels enabled for this event type. Empty array indicates no channels are enabled." } } }, "OrgChannelConfigResponse": { "type": "object", "required": [ "org", "preferences" ], "properties": { "org": { "$ref": "#/components/schemas/OrgDetails", "description": "Org details" }, "preferences": { "type": "array", "items": { "$ref": "#/components/schemas/EventChannelConfig" }, "description": "Event-specific communication channel configurations for this org" } } }, "OrgDetails": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "Unique id of the org" }, "name": { "type": "string", "description": "Name of the org" } } }, "SecuritySettingsResponse": { "type": "object", "properties": { "cluster_preferences": { "$ref": "#/components/schemas/SecuritySettingsClusterPreferences", "description": "Cluster-level security preferences.", "nullable": true }, "org_preferences": { "type": "array", "items": { "$ref": "#/components/schemas/SecuritySettingsOrgPreferences" }, "description": "Org-level security preferences.", "nullable": true } }, "description": "Response type for security settings search." }, "SecuritySettingsClusterPreferences": { "type": "object", "properties": { "enable_partitioned_cookies": { "type": "boolean", "description": "Support embedded access when third-party cookies are blocked.", "nullable": true }, "cors_whitelisted_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed origins for CORS.", "nullable": true }, "csp_settings": { "$ref": "#/components/schemas/CspSettings", "description": "CSP (Content Security Policy) settings.", "nullable": true }, "saml_redirect_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed redirect hosts for SAML login.", "nullable": true }, "non_embed_access": { "$ref": "#/components/schemas/ClusterNonEmbedAccess", "description": "Non-embed access configuration at cluster level.", "nullable": true }, "trusted_auth_status": { "type": "string", "enum": [ "ENABLED", "DISABLED" ], "description": "Trusted authentication status at the cluster level.
Version: 26.6.0.cl or later", "nullable": true } }, "description": "Cluster-level security preferences." }, "CspSettings": { "type": "object", "properties": { "connect_src_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed URLs for connect-src directive.", "nullable": true }, "font_src_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed URLs for font-src directive.", "nullable": true }, "visual_embed_hosts": { "type": "array", "items": { "type": "string" }, "description": "Allowed hosts for visual embed (frame-ancestors directive).", "nullable": true }, "iframe_src_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed URLs for frame-src directive.", "nullable": true }, "img_src_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed URLs for img-src directive.", "nullable": true }, "script_src_urls": { "$ref": "#/components/schemas/ScriptSrcUrls", "description": "Script-src settings including URLs and enabled flag.", "nullable": true }, "style_src_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed URLs for style-src directive.", "nullable": true } }, "description": "CSP (Content Security Policy) settings." }, "ScriptSrcUrls": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether script-src customization is enabled.", "nullable": true }, "urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed URLs for script-src directive. Can only be set if enabled is true.", "nullable": true } }, "description": "Script-src CSP settings." }, "ClusterNonEmbedAccess": { "type": "object", "properties": { "block_full_app_access": { "type": "boolean", "description": "Block full application access for non-embedded usage.", "nullable": true }, "groups_with_access": { "type": "array", "items": { "$ref": "#/components/schemas/GroupInfo" }, "description": "Groups that have non-embed full app access.\nOnly applicable when orgs feature is disabled. Use org_preferences when org feature is enabled.", "nullable": true } }, "description": "Cluster-level non-embed access configuration." }, "GroupInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the group.", "nullable": true }, "name": { "type": "string", "description": "Name of the group.", "nullable": true } }, "description": "Group information for non-embed access." }, "SecuritySettingsOrgPreferences": { "type": "object", "properties": { "org": { "$ref": "#/components/schemas/SecuritySettingsOrgDetails", "description": "Org details (id and name).", "nullable": true }, "cors_whitelisted_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed origins for CORS for this org.", "nullable": true }, "non_embed_access": { "$ref": "#/components/schemas/OrgNonEmbedAccess", "description": "Non-embed access configuration for this org.", "nullable": true }, "trusted_auth_status": { "type": "string", "enum": [ "ENABLED", "DISABLED" ], "description": "Trusted authentication status for this org.
Version: 26.6.0.cl or later", "nullable": true } }, "description": "Org-level security preferences." }, "SecuritySettingsOrgDetails": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "Unique identifier of the org.", "nullable": true }, "name": { "type": "string", "description": "Name of the org.", "nullable": true } }, "description": "Org details for security settings." }, "OrgNonEmbedAccess": { "type": "object", "properties": { "block_full_app_access": { "type": "boolean", "description": "Block full application access for non-embedded usage.", "nullable": true }, "groups_with_access": { "type": "array", "items": { "$ref": "#/components/schemas/GroupInfo" }, "description": "Groups that have non-embed full app access.", "nullable": true } }, "description": "Org-level non-embed access configuration." }, "OrgResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "Unique identifier of the Org.", "nullable": true }, "name": { "type": "string", "description": "Name of the Org.", "nullable": true }, "status": { "type": "string", "enum": [ "ACTIVE", "IN_ACTIVE" ], "description": "Status of the Org.", "nullable": true }, "description": { "type": "string", "description": "Description of the Org.", "nullable": true }, "visibility": { "type": "string", "enum": [ "SHOW", "HIDDEN" ], "description": "Visibility of the Org.", "nullable": true } } }, "Tag": { "type": "object", "required": [ "name", "id" ], "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "color": { "type": "string", "nullable": true }, "deleted": { "type": "boolean", "nullable": true }, "hidden": { "type": "boolean", "nullable": true }, "external": { "type": "boolean", "nullable": true }, "deprecated": { "type": "boolean", "nullable": true }, "creation_time_in_millis": { "type": "number", "format": "float", "nullable": true }, "modification_time_in_millis": { "type": "number", "format": "float", "nullable": true }, "author_id": { "type": "string", "nullable": true }, "modifier_id": { "type": "string", "nullable": true }, "owner_id": { "type": "string", "nullable": true } } }, "UserGroupResponse": { "type": "object", "required": [ "display_name", "id", "name", "visibility" ], "properties": { "obj_id": { "type": "string", "description": "Custom object ID (obj_id) of the group, if one is set.
Version: 26.9.0.cl or later", "nullable": true }, "author_id": { "type": "string", "description": "The unique identifier of the object", "nullable": true }, "complete_detail": { "type": "boolean", "description": "Indicates whether the response has complete detail of the group.", "nullable": true }, "content": { "type": "object", "description": "Content details of the group", "nullable": true }, "creation_time_in_millis": { "type": "number", "format": "float", "description": "Creation time of the group in milliseconds", "nullable": true }, "default_liveboards": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, "description": "Liveboards that are assigned as default Liveboards to the group.", "nullable": true }, "deleted": { "type": "boolean", "description": "Indicates whether the group is deleted", "nullable": true }, "deprecated": { "type": "boolean", "description": "Indicates whether the group is deprecated", "nullable": true }, "description": { "type": "string", "description": "Description of the group", "nullable": true }, "display_name": { "type": "string", "description": "Display name of the group." }, "external": { "type": "boolean", "description": "Indicates whether the group is external", "nullable": true }, "generation_number": { "type": "integer", "format": "int32", "description": "Generation number of the group", "nullable": true }, "hidden": { "type": "boolean", "description": "Indicates whether the group is hidden", "nullable": true }, "id": { "type": "string", "description": "The unique identifier of the object" }, "index": { "type": "integer", "format": "int32", "description": "Index number of the group", "nullable": true }, "index_version": { "type": "integer", "format": "int32", "description": "Index version number of the group", "nullable": true }, "metadata_version": { "type": "integer", "format": "int32", "description": "Metadata version number of the group", "nullable": true }, "modification_time_in_millis": { "type": "number", "format": "float", "description": "Last modified time of the group in milliseconds.", "nullable": true }, "modifier_id": { "type": "string", "description": "The unique identifier of the object", "nullable": true }, "name": { "type": "string", "description": "Name of the group." }, "orgs": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, "description": "Orgs in which group exists.", "nullable": true }, "owner_id": { "type": "string", "description": "The unique identifier of the object", "nullable": true }, "parent_type": { "type": "string", "enum": [ "USER", "GROUP" ], "description": "Parent type of the group.", "nullable": true }, "privileges": { "type": "array", "items": { "type": "string" }, "description": "Privileges which are assigned to the group", "nullable": true }, "sub_groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, "description": "Groups who are part of the group", "nullable": true }, "system_group": { "type": "boolean", "description": "Indicates whether the group is a system group.", "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, "description": "Tags associated with the group.", "nullable": true }, "type": { "type": "string", "enum": [ "LOCAL_GROUP", "LDAP_GROUP", "TEAM_GROUP", "TENANT_GROUP" ], "description": "Type of the group.", "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, "description": "Users who are part of the group.", "nullable": true }, "visibility": { "type": "string", "enum": [ "SHARABLE", "NON_SHARABLE" ], "description": "Visibility of the group. The SHARABLE makes a group visible to other users and groups, and thus allows them to share objects." }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/Role" }, "description": "List of roles assgined to the user", "nullable": true } } }, "Role": { "type": "object", "properties": { "id": { "type": "string", "description": "id of the role", "nullable": true }, "name": { "type": "string", "description": "name of the role", "nullable": true } } }, "MetadataListItemInput": { "type": "object", "properties": { "identifier": { "type": "string", "description": "Unique ID or name of the metadata.", "nullable": true }, "obj_identifier": { "type": "string", "description": "CustomObjectId of the metadata.", "nullable": true }, "name_pattern": { "type": "string", "description": "A pattern to match the case-insensitive name of the metadata object. User % for a wildcard match.", "nullable": true }, "type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "LOGICAL_COLUMN", "CONNECTION", "TAG", "USER", "USER_GROUP", "LOGICAL_RELATIONSHIP", "INSIGHT_SPEC", "COLLECTION" ], "description": "Type of metadata. Required if the name of the object is set as identifier. This attribute is optional when the object GUID is specified as identifier.\n1. Liveboard\n2. Answers\n3. LOGICAL_TABLE for any data object such as table, worksheet or view.\n4. LOGICAL_COLUMN for a column of any data object such as table, worksheet or view.\n5. CONNECTION for creating or modify data connections.\n6. TAG for tag objects.\n7. USER for user objects.\n8. USER_GROUP for group objects.\n9. LOGICAL_RELATIONSHIP for table or worksheet joins. A join combines from one or several data object by using matching values\n10. INSIGHT_SPEC for SpotIQ objects\n11. COLLECTION for collection objects", "nullable": true }, "subtypes": { "type": "array", "items": { "type": "string", "enum": [ "ONE_TO_ONE_LOGICAL", "WORKSHEET", "PRIVATE_WORKSHEET", "USER_DEFINED", "AGGR_WORKSHEET", "SQL_VIEW" ] }, "description": "List of subtype of metadata. Applies for LOGICAL_TABLE type with the following valid values.\n1. ONE_TO_ONE_LOGICAL\n2. WORKSHEET\n3. PRIVATE_WORKSHEET.\n4. USER_DEFINED.\n5. AGGR_WORKSHEET.\n6. SQL_VIEW
Version: 10.11.0.cl or later", "nullable": true } } }, "PermissionInput": { "type": "object", "required": [ "principal", "share_mode" ], "properties": { "principal": { "$ref": "#/components/schemas/PrincipalsInput", "description": "Details of users or groups." }, "share_mode": { "type": "string", "enum": [ "READ_ONLY", "MODIFY", "NO_ACCESS" ], "description": "Object share mode." } }, "description": "Details of users or groups." }, "ExcludeMetadataListItemInput": { "type": "object", "required": [ "identifier", "type" ], "properties": { "identifier": { "type": "string", "description": "Unique ID or name of the metadata." }, "type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "LOGICAL_COLUMN", "CONNECTION", "TAG", "USER", "USER_GROUP", "LOGICAL_RELATIONSHIP", "INSIGHT_SPEC", "COLLECTION" ], "description": "Type of metadata. Required if the name of the object is set as identifier. This attribute is optional when the object GUID is specified as identifier.\n1. Liveboard\n2. Answers\n3. LOGICAL_TABLE for any data object such as table, worksheet or view\n4. LOGICAL_COLUMN for a column of any data object such as table, worksheet or view\n5. CONNECTION for connection objects\n6. TAG for tag objects\n7. USER for user objects\n8. USER_GROUP for group objects\n9. LOGICAL_RELATIONSHIP for table or worksheet joins. A join combines from one or several data object by using matching values.\n10. INSIGHT_SPEC for SpotIQ objects\n11. COLLECTION for collection objects" } } }, "FavoriteObjectOptionsInput": { "type": "object", "properties": { "include": { "type": "boolean", "default": false, "description": "Includes objects marked as favorite for the specified users.", "nullable": true }, "user_identifiers": { "type": "array", "items": { "type": "string" }, "description": "Unique ID or name of the users. If not specified, the favorite objects of current logged in user are returned.", "nullable": true } }, "description": "Favorite object options." }, "LiveboardDetailsInput": { "type": "object", "properties": { "liveboard_filters": { "type": "boolean", "default": true, "description": "Includes Liveboard filters.", "nullable": true }, "liveboard_tabs": { "type": "boolean", "default": true, "description": "Includes Liveboard tabs.", "nullable": true }, "container_layouts": { "type": "boolean", "default": true, "description": "Includes the layout of Liveboard visualizations.", "nullable": true }, "visualizations": { "type": "boolean", "default": true, "description": "Includes Liveboard visualizations.", "nullable": true }, "parameter_overrides": { "type": "boolean", "default": true, "description": "Includes parameter overrides.", "nullable": true }, "personalized_views": { "type": "boolean", "default": false, "description": "Includes personalised views. Personalised views are also included when\ninclude_personalised_views is true.", "nullable": true } }, "description": "Parts of a Liveboard's metadata_detail to return in a metadata search." }, "MetadataSearchSortOptions": { "type": "object", "properties": { "field_name": { "type": "string", "enum": [ "NAME", "DISPLAY_NAME", "AUTHOR", "CREATED", "MODIFIED", "VIEWS", "FAVORITES", "LAST_ACCESSED" ], "description": "Name of the field to apply the sort on.", "nullable": true }, "order": { "type": "string", "enum": [ "ASC", "DESC" ], "description": "Sort order : ASC(Ascending) or DESC(Descending).", "nullable": true } }, "description": "Sort options." }, "MetadataSearchResponse": { "type": "object", "required": [ "metadata_type" ], "properties": { "metadata_id": { "type": "string", "description": "Unique identifier of the metadata.", "nullable": true }, "metadata_name": { "type": "string", "description": "Name of the metadata.", "nullable": true }, "metadata_type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "LOGICAL_COLUMN", "CONNECTION", "TAG", "USER", "USER_GROUP", "LOGICAL_RELATIONSHIP", "INSIGHT_SPEC", "COLLECTION" ], "description": "Type of the metadata." }, "metadata_obj_id": { "type": "string", "description": "Custom identifier of the metadata.\n(Available from 10.8.0.cl onwards)", "nullable": true }, "dependent_objects": { "type": "object", "description": "Details of dependent objects of the metadata objects.", "nullable": true }, "incomplete_objects": { "type": "array", "items": { "type": "object" }, "description": "Details of incomplete information of the metadata objects if any.", "nullable": true }, "metadata_detail": { "type": "object", "description": "Complete details of the metadata objects.", "nullable": true }, "metadata_header": { "type": "object", "description": "Header information of the metadata objects.", "nullable": true }, "visualization_headers": { "type": "array", "items": { "type": "object" }, "description": "Visualization header information of the metadata objects.", "nullable": true }, "stats": { "type": "object", "description": "Stats of the metadata object. Includes views, favorites, last_accessed.", "nullable": true } }, "description": "Metadata Search Response Object." }, "GetAsyncImportStatusResponse": { "type": "object", "properties": { "status_list": { "type": "array", "items": { "$ref": "#/components/schemas/ImportEPackAsyncTaskStatus" }, "description": "List of task statuses.", "nullable": true }, "last_batch": { "type": "boolean", "description": "Indicates whether there are more task statuses to fetch.", "nullable": true } } }, "ImportEPackAsyncTaskStatus": { "type": "object", "properties": { "tenant_id": { "type": "string", "description": "GUID of tenant from which the task is initiated.", "nullable": true }, "org_id": { "type": "integer", "format": "int32", "description": "Organisation ID of the user who initiated the task.", "nullable": true }, "task_id": { "type": "string", "description": "Unique identifier for the task.", "nullable": true }, "task_name": { "type": "string", "description": "Name of the task.", "nullable": true }, "import_response": { "type": "object", "description": "Response of imported objects so far.", "nullable": true }, "task_status": { "type": "string", "enum": [ "COMPLETED", "IN_QUEUE", "IN_PROGRESS", "FAILED" ], "description": "Current status of the task.", "nullable": true }, "author_id": { "type": "string", "description": "ID of the user who initiated the task.", "nullable": true }, "import_policy": { "type": "string", "enum": [ "PARTIAL", "ALL_OR_NONE", "VALIDATE_ONLY", "PARTIAL_OBJECT" ], "description": "Policy used for the import task.", "nullable": true }, "created_at": { "type": "number", "format": "float", "description": "Time when the task was created (in ms since epoch).", "nullable": true }, "in_progress_at": { "type": "number", "format": "float", "description": "Time when the task started (in ms since epoch).", "nullable": true }, "completed_at": { "type": "number", "format": "float", "description": "Time when the task was completed (in ms since epoch).", "nullable": true }, "total_object_count": { "type": "integer", "format": "int32", "description": "Total number of objects to process.", "nullable": true }, "object_processed_count": { "type": "integer", "format": "int32", "description": "Number of objects processed so far.", "nullable": true }, "modified_at": { "type": "number", "format": "float", "description": "Last time the task status was updated (in ms since epoch).", "nullable": true }, "author_display_name": { "type": "string", "description": "Display name of the user who initiated the task.", "nullable": true } } }, "SqlQueryResponse": { "type": "object", "required": [ "metadata_id", "metadata_name", "metadata_type", "sql_queries" ], "properties": { "metadata_id": { "type": "string", "description": "Unique identifier of the metadata." }, "metadata_name": { "type": "string", "description": "Name of the metadata." }, "metadata_type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "LOGICAL_COLUMN", "CONNECTION", "TAG", "USER", "USER_GROUP", "LOGICAL_RELATIONSHIP" ], "description": "Type of the metadata." }, "sql_queries": { "type": "array", "items": { "$ref": "#/components/schemas/SqlQuery" }, "description": "SQL query details of metadata objects." } } }, "SqlQuery": { "type": "object", "required": [ "metadata_id", "metadata_name", "sql_query" ], "properties": { "metadata_id": { "type": "string", "description": "Unique identifier of the metadata." }, "metadata_name": { "type": "string", "description": "Name of the metadata." }, "sql_query": { "type": "string", "description": "SQL query of a metadata object." } }, "description": "Response format associated with fetch SQL query api" }, "PdfOptionsInput": { "type": "object", "properties": { "page_size": { "type": "string", "enum": [ "A4", "CONTINUOUS" ], "description": "Size of PDF page. `A4` generates a paginated A4 PDF. `CONTINUOUS` generates a continuous PDF that matches the Liveboard layout. Each Liveboard tab has its own page of variable length. Defaults to `A4` if not specified.
Beta Version: 26.5.0.cl or later", "nullable": true }, "zoom_level": { "type": "integer", "format": "int32", "description": "Zoom level percentage for the PDF. Only applicable when `page_size` is `CONTINUOUS`. Acceptable values are integers in the range [45, 175]. Defaults to 100 if not specified.
Beta Version: 26.5.0.cl or later", "nullable": true }, "include_cover_page": { "type": "boolean", "default": true, "description": "Indicates whether to include the cover page with the Liveboard title.", "nullable": true }, "include_custom_logo": { "type": "boolean", "default": true, "description": "Indicates whether to include customized wide logo in the footer if available.", "nullable": true }, "include_filter_page": { "type": "boolean", "default": true, "description": "Indicates whether to include a page with all applied filters. For `CONTINUOUS` page_size, this parameter indicates whether to include the filter header.", "nullable": true }, "include_page_number": { "type": "boolean", "default": true, "description": "Indicates whether to include page number in the footer of each page.", "nullable": true }, "page_orientation": { "type": "string", "enum": [ "PORTRAIT", "LANDSCAPE" ], "default": "PORTRAIT", "description": "Page orientation of the PDF.", "nullable": true }, "truncate_table": { "type": "boolean", "default": false, "description": "Indicates whether to include only the first page of the tables.", "nullable": true }, "page_footer_text": { "type": "string", "description": "Text to include in the footer of each page.", "nullable": true } } }, "PngOptionsInput": { "type": "object", "properties": { "include_cover_page": { "type": "boolean", "default": false, "description": "Indicates whether to include the cover page with the Liveboard title.", "nullable": true }, "include_filter_page": { "type": "boolean", "default": false, "description": "Indicates whether to include a page with all applied filters.", "nullable": true }, "personalised_view_id": { "type": "string", "description": "Indicates personalised view of the Liveboard in case of png", "nullable": true }, "image_resolution": { "type": "integer", "format": "int32", "description": "Desired width of the Liveboard image in pixels. Ex. 1920 for Full HD image
Beta Version: 10.9.0.cl or later", "nullable": true }, "image_scale": { "type": "integer", "format": "int32", "description": "The scale of the image in percentage. Ex. 100 for 100% scale.
Beta Version: 10.9.0.cl or later", "nullable": true }, "include_header": { "type": "boolean", "default": false, "description": "Indicates whether to include the header of the liveboard.
Beta Version: 10.9.0.cl or later", "nullable": true } } }, "RegionalSettingsInput": { "type": "object", "properties": { "currency_format": { "type": "string", "description": "ISO code to be appended with currency values.", "nullable": true, "enum": [ "ADP", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARA", "ARS", "ATS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BEF", "BGL", "BGM", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOP", "BOV", "BRL", "BSD", "BTN", "BUK", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLE", "CLP", "CNX", "CNY", "COP", "COU", "CRC", "CSK", "CUC", "CUP", "CVE", "CYP", "CZK", "DDM", "DEM", "DJF", "DKK", "DOP", "DZD", "ECS", "ECV", "EEK", "EGP", "ERN", "ESP", "ETB", "EUR", "FIM", "FJD", "FKP", "FRF", "GBP", "GEK", "GEL", "GHS", "GIP", "GMD", "GNF", "GNS", "GQE", "GRD", "GTQ", "GWE", "GWP", "GYD", "HKD", "HNL", "HRD", "HRK", "HTG", "HUF", "IDR", "IEP", "ILP", "ILS", "INR", "IQD", "IRR", "ISK", "ITL", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LTT", "LUC", "LUF", "LUL", "LVL", "LVR", "LYD", "MAD", "MAF", "MCF", "MDC", "MDL", "MGA", "MGF", "MKD", "MLF", "MMK", "MNT", "MOP", "MRU", "MTL", "MTP", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZE", "MZN", "NAD", "NGN", "NIO", "NLG", "NOK", "NPR", "NZD", "OMR", "PAB", "PEI", "PEN", "PGK", "PHP", "PKR", "PLN", "PTE", "PYG", "QAR", "RHD", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SIT", "SKK", "SLL", "SOS", "SRD", "SRG", "SSP", "STN", "SUR", "SVC", "SYP", "SZL", "THB", "TJR", "TJS", "TMT", "TND", "TOP", "TPE", "TRY", "TTD", "TWD", "TZS", "UAH", "UAK", "UGX", "USD", "UYU", "UYW", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XCD", "XDR", "XEU", "XFO", "XFU", "XOF", "XPD", "XPF", "XPT", "XRE", "XSU", "XTS", "XUA", "XXX", "YDD", "YER", "ZAR", "ZMW" ] }, "user_locale": { "type": "string", "description": "Indicates the locale to be used for all formattings.", "nullable": true, "enum": [ "en-CA", "en-GB", "en-US", "de-DE", "ja-JP", "zh-CN", "pt-BR", "fr-FR", "fr-CA", "es-US", "da-DK", "es-ES", "fi-FI", "sv-SE", "nb-NO", "pt-PT", "nl-NL", "it-IT", "ru-RU", "en-IN", "de-CH", "en-NZ", "es-MX", "en-AU", "zh-Hant", "ko-KR", "en-DE" ] }, "number_format_locale": { "type": "string", "description": "Indicates the locale to be used for number formatting.", "nullable": true, "enum": [ "en-CA", "en-GB", "en-US", "de-DE", "ja-JP", "zh-CN", "pt-BR", "fr-FR", "fr-CA", "es-US", "da-DK", "es-ES", "fi-FI", "sv-SE", "nb-NO", "pt-PT", "nl-NL", "it-IT", "ru-RU", "en-IN", "de-CH", "en-NZ", "es-MX", "en-AU", "zh-Hant", "ko-KR", "en-DE" ] }, "date_format_locale": { "type": "string", "description": "Indicates the locale to be used for date formatting.", "nullable": true, "enum": [ "en-CA", "en-GB", "en-US", "de-DE", "ja-JP", "zh-CN", "pt-BR", "fr-FR", "fr-CA", "es-US", "da-DK", "es-ES", "fi-FI", "sv-SE", "nb-NO", "pt-PT", "nl-NL", "it-IT", "ru-RU", "en-IN", "de-CH", "en-NZ", "es-MX", "en-AU", "zh-Hant", "ko-KR", "en-DE" ] } } }, "AnswerPngOptionsInput": { "type": "object", "properties": { "x_resolution": { "type": "integer", "format": "int32", "description": "Desired width of the answer image in pixels. Ex. 1920 for Full HD image
Beta Version: 26.6.0.cl or later", "nullable": true }, "y_resolution": { "type": "integer", "format": "int32", "description": "Desired height of the answer image in pixels. Ex. 1080 for Full HD image
Beta Version: 26.6.0.cl or later", "nullable": true }, "scaling": { "type": "integer", "format": "int32", "description": "The scale of the image in percentage. Ex. 100 for 100% scale.
Beta Version: 26.6.0.cl or later", "nullable": true } } }, "PermissionOfPrincipalsResponse": { "type": "object", "properties": { "principal_permission_details": { "type": "object", "nullable": true } } }, "PermissionOfMetadataResponse": { "type": "object", "properties": { "metadata_permission_details": { "type": "object", "nullable": true } } }, "ObjectPrivilegesMetadataInput": { "type": "object", "required": [ "identifier" ], "properties": { "type": { "type": "string", "enum": [ "LOGICAL_TABLE" ], "description": "Type of metadata object.\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.", "nullable": true }, "identifier": { "type": "string", "description": "Unique ID or name of the metadata object." } } }, "ObjectPrivilegesOfMetadataResponse": { "type": "object", "properties": { "metadata_object_privileges": { "type": "object", "nullable": true } } }, "PrincipalsInput": { "type": "object", "required": [ "identifier" ], "properties": { "identifier": { "type": "string", "description": "Unique ID or name of the principal object such as a user or group." }, "type": { "type": "string", "enum": [ "USER", "USER_GROUP" ], "description": "Principal type.", "nullable": true } } }, "PermissionsMetadataTypeInput": { "type": "object", "required": [ "identifier" ], "properties": { "type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "LOGICAL_COLUMN", "CONNECTION", "COLLECTION" ], "description": " Type of metadata object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.", "nullable": true }, "identifier": { "type": "string", "description": "Unique ID or name of the metadata object." } }, "description": "MetadataType InputType used in Permission API's" }, "ColumnSecurityRuleTableInput": { "type": "object", "properties": { "identifier": { "type": "string", "description": "Name or GUID of the table", "nullable": true }, "obj_identifier": { "type": "string", "description": "Object ID of the table", "nullable": true } } }, "ColumnSecurityRuleResponse": { "type": "object", "properties": { "table_guid": { "type": "string", "description": "GUID of the table for which the column security rules are fetched", "nullable": true }, "obj_id": { "type": "string", "description": "Object ID of the table for which the column security rules are fetched", "nullable": true }, "column_security_rules": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnSecurityRule" }, "description": "Array containing column security rule objects", "nullable": true } } }, "ColumnSecurityRule": { "type": "object", "required": [ "column" ], "properties": { "column": { "$ref": "#/components/schemas/ColumnSecurityRuleColumn", "description": "Information about the column" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnSecurityRuleGroup" }, "description": "Array of groups that have access to this column", "nullable": true }, "source_table_details": { "$ref": "#/components/schemas/ColumnSecurityRuleSourceTable", "description": "Information about the source table", "nullable": true } } }, "ColumnSecurityRuleColumn": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "The unique identifier of the column" }, "name": { "type": "string", "description": "The name of the column" } } }, "ColumnSecurityRuleGroup": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "The unique identifier of the group" }, "name": { "type": "string", "description": "The name of the group" } } }, "ColumnSecurityRuleSourceTable": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "The unique identifier of the source table" }, "name": { "type": "string", "description": "The name of the source table" } } }, "SearchDataResponse": { "type": "object", "required": [ "contents" ], "properties": { "contents": { "type": "array", "items": { "$ref": "#/components/schemas/AnswerContent" }, "description": "Data content of metadata objects" } }, "description": "Response format associated with the search data API." }, "AnswerContent": { "type": "object", "required": [ "available_data_row_count", "column_names", "data_rows", "record_offset", "record_size", "returned_data_row_count", "sampling_ratio" ], "properties": { "available_data_row_count": { "type": "integer", "format": "int32", "description": "Total available data row count." }, "column_names": { "type": "array", "items": { "type": "string" }, "description": "Name of the columns." }, "data_rows": { "type": "array", "items": { "type": "object" }, "description": "Rows of data set." }, "record_offset": { "type": "integer", "format": "int32", "description": "The starting record number from where the records should be included." }, "record_size": { "type": "integer", "format": "int32", "description": "The number of records that should be included." }, "returned_data_row_count": { "type": "integer", "format": "int32", "description": "Total returned data row count." }, "sampling_ratio": { "type": "number", "format": "float", "description": "Sampling ratio (0 to 1). If the query was sampled, it is the ratio of keys returned in the data set to the total number of keys expected in the query. If the value is 1.0, this means that the complete result is returned." } } }, "LiveboardDataResponse": { "type": "object", "required": [ "metadata_id", "metadata_name", "contents" ], "properties": { "metadata_id": { "type": "string", "description": "The unique identifier of the object" }, "metadata_name": { "type": "string", "description": "Name of the metadata object" }, "contents": { "type": "array", "items": { "$ref": "#/components/schemas/LiveboardContent" }, "description": "Data content of metadata objects" } } }, "LiveboardContent": { "type": "object", "required": [ "available_data_row_count", "column_names", "data_rows", "record_offset", "record_size", "returned_data_row_count", "sampling_ratio" ], "properties": { "available_data_row_count": { "type": "integer", "format": "int32", "description": "Total available data row count." }, "column_names": { "type": "array", "items": { "type": "string" }, "description": "Name of the columns." }, "data_rows": { "type": "array", "items": { "type": "object" }, "description": "Rows of data set." }, "record_offset": { "type": "integer", "format": "int32", "description": "The starting record number from where the records should be included." }, "record_size": { "type": "integer", "format": "int32", "description": "The number of records that should be included." }, "returned_data_row_count": { "type": "integer", "format": "int32", "description": "Total returned data row count." }, "sampling_ratio": { "type": "number", "format": "float", "description": "Sampling ratio (0 to 1). If the query was sampled, it is the ratio of keys returned in the data set to the total number of keys expected in the query. If the value is 1.0, this means that the complete result is returned." }, "visualization_id": { "type": "string", "description": "Unique ID of the visualization.", "nullable": true }, "visualization_name": { "type": "string", "description": "Name of the visualization.", "nullable": true } } }, "AnswerDataResponse": { "type": "object", "required": [ "metadata_id", "metadata_name", "contents" ], "properties": { "metadata_id": { "type": "string", "description": "The unique identifier of the object" }, "metadata_name": { "type": "string", "description": "Name of the metadata object" }, "contents": { "type": "array", "items": { "$ref": "#/components/schemas/AnswerContent" }, "description": "Data content of metadata objects" } }, "description": "Response format associated with fetch data api" }, "LogResponse": { "type": "object", "required": [ "date", "log" ], "properties": { "date": { "type": "string", "description": "Date timestamp of the log entry" }, "log": { "type": "string", "description": "Log data" } } }, "RepoConfigObject": { "type": "object", "properties": { "repository_url": { "type": "string", "description": "Remote repository URL configured", "nullable": true }, "username": { "type": "string", "description": "Username to authenticate connection to the version control system", "nullable": true }, "commit_branch_name": { "type": "string", "description": "Name of the remote branch where objects from this Thoughtspot instance will be versioned.", "nullable": true }, "branches": { "type": "array", "items": { "type": "string" }, "description": "Branches that have been pulled in local repository", "nullable": true }, "enable_guid_mapping": { "type": "boolean", "description": "Maintain mapping of guid for the deployment to an instance", "nullable": true }, "configuration_branch_name": { "type": "string", "description": "Name of the branch where the configuration files related to operations between Thoughtspot and version control repo should be maintained.", "nullable": true }, "org": { "$ref": "#/components/schemas/Org", "description": "Details of the Org", "nullable": true } } }, "CommitHistoryResponse": { "type": "object", "required": [ "committer", "author", "comment", "commit_time", "commit_id", "branch" ], "properties": { "committer": { "$ref": "#/components/schemas/CommiterType", "description": "Repository user using which changes were committed" }, "author": { "$ref": "#/components/schemas/AuthorType", "description": "Thoughtspot user who commits the changes" }, "comment": { "type": "string", "description": "Comments associated with the commit" }, "commit_time": { "type": "string", "description": "Time at which the changes were committed." }, "commit_id": { "type": "string", "description": "SHA id associated with the commit" }, "branch": { "type": "string", "description": "Branch where changes were committed" } } }, "CommiterType": { "type": "object", "properties": { "email": { "type": "string", "description": "Email id of the committer", "nullable": true }, "username": { "type": "string", "description": "Username of the committer", "nullable": true } } }, "AuthorType": { "type": "object", "properties": { "email": { "type": "string", "description": "Email id of the committer", "nullable": true }, "username": { "type": "string", "description": "Username of the committer", "nullable": true } } }, "ConnectionInput": { "type": "object", "properties": { "identifier": { "type": "string", "description": "Unique ID or name of the connection.", "nullable": true }, "name_pattern": { "type": "string", "description": "A pattern to match case-insensitive name of the connection object. User `%` for a wildcard match.", "nullable": true }, "data_warehouse_objects": { "type": "array", "items": { "$ref": "#/components/schemas/DataWarehouseObjectInput" }, "description": "Filter options for databases, schemas, tables and columns.", "nullable": true } } }, "DataWarehouseObjectInput": { "type": "object", "properties": { "database": { "type": "string", "description": "Name of the database.", "nullable": true }, "schema": { "type": "string", "description": "Name of the schema within the database.", "nullable": true }, "table": { "type": "string", "description": "Name of the table within the schema.", "nullable": true }, "column": { "type": "string", "description": "Name of the column within the table.", "nullable": true } } }, "SortOptionInput": { "type": "object", "properties": { "field_name": { "type": "string", "enum": [ "NAME", "DISPLAY_NAME", "AUTHOR", "CREATED", "MODIFIED", "LAST_ACCESSED", "SYNCED", "VIEWS", "USER_STATE", "ROW_COUNT" ], "description": "Name of the field to apply the sort on.", "nullable": true }, "order": { "type": "string", "enum": [ "ASC", "DESC" ], "description": "Sort order : ASC(Ascending) or DESC(Descending).", "nullable": true } } }, "SearchConnectionResponse": { "type": "object", "required": [ "id", "name", "data_warehouse_type" ], "properties": { "id": { "type": "string", "description": "Unique ID of the connection." }, "name": { "type": "string", "description": "Name of the connection." }, "obj_id": { "type": "string", "description": "Custom object ID (obj_id) of the connection, if one is set.
Version: 26.9.0.cl or later", "nullable": true }, "description": { "type": "string", "description": "Description of the connection.", "nullable": true }, "data_warehouse_type": { "type": "string", "enum": [ "SNOWFLAKE", "AMAZON_REDSHIFT", "GOOGLE_BIGQUERY", "AZURE_SYNAPSE", "TERADATA", "SAP_HANA", "STARBURST", "ORACLE_ADW", "DATABRICKS", "DENODO", "DREMIO", "TRINO", "PRESTO", "POSTGRES", "SQLSERVER", "MYSQL", "GENERIC_JDBC", "AMAZON_RDS_POSTGRESQL", "AMAZON_AURORA_POSTGRESQL", "AMAZON_RDS_MYSQL", "AMAZON_AURORA_MYSQL", "LOOKER", "AMAZON_ATHENA", "SINGLESTORE", "GCP_SQLSERVER", "GCP_ALLOYDB_POSTGRESQL", "GCP_POSTGRESQL", "GCP_MYSQL", "MODE", "GOOGLE_SHEETS", "FALCON", "FALCON_ONPREM", "CLICKHOUSE", "IOMETE" ], "description": "Type of data warehouse." }, "data_warehouse_objects": { "$ref": "#/components/schemas/DataWarehouseObjects", "description": "List of Data warehouse objects", "nullable": true }, "details": { "type": "object", "description": "Details of the connection.", "nullable": true } } }, "DataWarehouseObjects": { "type": "object", "required": [ "databases" ], "properties": { "databases": { "type": "array", "items": { "$ref": "#/components/schemas/Database" }, "description": "Databases of the connection." } } }, "Database": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the database." }, "schemas": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaObject" }, "description": "Schemas of the database.", "nullable": true }, "auto_created": { "type": "boolean", "description": "Determines if the object is auto created.", "nullable": true } } }, "SchemaObject": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the schema." }, "tables": { "type": "array", "items": { "$ref": "#/components/schemas/Table" }, "description": "Tables in the schema.", "nullable": true } } }, "Table": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Name of the table." }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/Column" }, "description": "Columns of the table.", "nullable": true }, "type": { "type": "string", "description": "Type of table. Either view or table", "nullable": true }, "description": { "type": "string", "description": "Description of the table", "nullable": true }, "selected": { "type": "boolean", "description": "Determines if the table is selected", "nullable": true }, "linked": { "type": "boolean", "description": "Determines if the table is linked", "nullable": true }, "relationships": { "type": "array", "items": { "type": "object" }, "description": "List of relationships for the table", "nullable": true } } }, "Column": { "type": "object", "required": [ "name", "data_type" ], "properties": { "name": { "type": "string", "description": "Name of the column" }, "data_type": { "type": "string", "description": "Data type of the column" }, "is_aggregate": { "type": "string", "description": "Determines if the column schema is an aggregate", "nullable": true }, "can_import": { "type": "boolean", "description": "Determines if the column schema can be imported", "nullable": true }, "selected": { "type": "boolean", "description": "Determines if the table is selected", "nullable": true }, "is_linked_active": { "type": "boolean", "description": "Determines if the table is linked", "nullable": true } } }, "SearchRoleResponse": { "type": "object", "required": [ "id", "name", "description", "privileges" ], "properties": { "id": { "type": "string", "description": "Unique Id of the role." }, "name": { "type": "string", "description": "Name of the role" }, "obj_id": { "type": "string", "description": "Custom object ID (obj_id) of the role, if one is set.
Version: 26.9.0.cl or later", "nullable": true }, "description": { "type": "string", "description": "Description of the role" }, "groups_assigned_count": { "type": "integer", "format": "int32", "description": "number of groups assigned with this role", "nullable": true }, "orgs": { "type": "array", "items": { "$ref": "#/components/schemas/GenericInfo" }, "description": "Orgs in which role exists.", "nullable": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GenericInfo" }, "description": "Details of groups assigned with this role", "nullable": true }, "privileges": { "type": "array", "items": { "type": "string", "enum": [ "UNKNOWN", "ADMINISTRATION", "AUTHORING", "USERDATAUPLOADING", "DATADOWNLOADING", "USERMANAGEMENT", "SECURITYMANAGEMENT", "LOGICALMODELING", "DATAMANAGEMENT", "TAGMANAGEMENT", "SHAREWITHALL", "SYSTEMMANAGEMENT", "JOBSCHEDULING", "A3ANALYSIS", "EXPERIMENTALFEATUREPRIVILEGE", "BYPASSRLS", "RANALYSIS", "DISABLE_PINBOARD_CREATION", "DEVELOPER", "APPLICATION_ADMINISTRATION", "USER_ADMINISTRATION", "GROUP_ADMINISTRATION", "BACKUP_ADMINISTRATION", "SYSTEM_INFO_ADMINISTRATION", "ENABLESPOTAPPCREATION", "SYNCMANAGEMENT", "ORG_ADMINISTRATION", "ROLE_ADMINISTRATION", "AUTHENTICATION_ADMINISTRATION", "BILLING_INFO_ADMINISTRATION", "PREVIEW_THOUGHTSPOT_SAGE", "LIVEBOARD_VERIFIER", "CAN_MANAGE_CUSTOM_CALENDAR", "CAN_CREATE_OR_EDIT_CONNECTIONS", "CAN_CONFIGURE_CONNECTIONS", "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", "CAN_MANAGE_VERSION_CONTROL", "THIRDPARTY_ANALYSIS", "CONTROL_TRUSTED_AUTH", "CAN_CREATE_CATALOG", "ALLOW_NON_EMBED_FULL_APP_ACCESS", "CAN_ACCESS_ANALYST_STUDIO", "CAN_MANAGE_ANALYST_STUDIO", "CAN_VIEW_FOLDERS", "CAN_MODIDY_FOLDERS", "CAN_MANAGE_VARIABLES", "CAN_MANAGE_AGENTSPOT", "CAN_ACCESS_AGENTSPOT", "PREVIEW_DOCUMENT_SEARCH", "CAN_SETUP_VERSION_CONTROL", "CAN_MANAGE_WEBHOOKS", "CAN_DOWNLOAD_VISUALS", "CAN_DOWNLOAD_DETAILED_DATA", "CAN_USE_SPOTTER", "CAN_MANAGE_SPOTTER", "CAN_CREATE_LIVEBOARD", "CAN_CREATE_ANSWERS", "CAN_ANALYZE_DATA", "CAN_ADMINISTER_SCHEDULES", "CAN_CREATE_KPI_ALERTS" ] }, "description": "Privileges granted to the role." }, "permission": { "type": "string", "enum": [ "READ_ONLY", "MODIFY", "NO_ACCESS" ], "description": "Permission details of the Role", "nullable": true }, "author_id": { "type": "string", "description": "Unique identifier of author of the role.", "nullable": true }, "modifier_id": { "type": "string", "description": "Unique identifier of modifier of the role.", "nullable": true }, "creation_time_in_millis": { "type": "object", "description": "Creation time of the role in milliseconds.", "nullable": true }, "modification_time_in_millis": { "type": "object", "description": "Last modified time of the role in milliseconds.", "nullable": true }, "deleted": { "type": "boolean", "description": "Indicates whether the role is deleted.", "nullable": true }, "deprecated": { "type": "boolean", "description": "Indicates whether the role is deprecated.", "nullable": true }, "external": { "type": "boolean", "description": "Indicates whether the role is external.", "nullable": true }, "hidden": { "type": "boolean", "description": "Indicates whether the role is hidden.", "nullable": true }, "shared_via_connection": { "type": "boolean", "description": "Indicates whether the role is shared via connection", "nullable": true } }, "description": "Response for search role api should handle hidden privileges as well." }, "Default_Action_Config_Search_Input": { "type": "object", "properties": { "visibility": { "type": "boolean", "description": "Custom action is available on all visualizations. Earlier naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.", "nullable": true } }, "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers." }, "ResponseCustomAction": { "type": "object", "required": [ "action_details", "default_action_config", "id", "name" ], "properties": { "action_details": { "$ref": "#/components/schemas/Action_details", "description": "`Type` and configuration data for custom actions" }, "default_action_config": { "$ref": "#/components/schemas/Default_action_config", "description": "Default custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers." }, "id": { "type": "string", "description": "Unique Id of the custom action." }, "obj_id": { "type": "string", "description": "Custom object ID (obj_id) of the custom action, if one is set.
Version: 26.9.0.cl or later", "nullable": true }, "metadata_association": { "type": "array", "items": { "$ref": "#/components/schemas/Metadata_Association_Item" }, "description": "Metadata objects to assign the the custom action to.", "nullable": true }, "name": { "type": "string", "description": "Unique name of the custom action." }, "user_groups": { "type": "array", "items": { "$ref": "#/components/schemas/Object_ID_And_Name" }, "description": "Unique ID or name of the User groups which are associated with the custom action.", "nullable": true } }, "description": "Custom action details" }, "Action_details": { "type": "object", "properties": { "CALLBACK": { "$ref": "#/components/schemas/CALLBACK", "description": "CALLBACK Custom Action Type", "nullable": true }, "URL": { "$ref": "#/components/schemas/URL", "description": "URL Custom Action Type", "nullable": true } }, "description": "Type and Configuration for Custom Actions" }, "CALLBACK": { "type": "object", "properties": { "reference": { "type": "string", "description": "Reference name of the SDK. By default, the value will be set to action name.", "nullable": true } }, "description": "CALLBACK Custom Action Type" }, "URL": { "type": "object", "required": [ "url" ], "properties": { "authentication": { "$ref": "#/components/schemas/Authentication", "description": "Authorization type for the custom action.", "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ParametersListItem" }, "description": "Query parameters for url.", "nullable": true }, "url": { "type": "string", "description": "Request Url for the Custom action." }, "reference": { "type": "string", "description": "Reference name of the SDK. By default, the value will be set to action name.", "nullable": true } }, "description": "URL Custom Action Type" }, "Authentication": { "type": "object", "properties": { "API_Key": { "$ref": "#/components/schemas/API_Key", "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters.", "nullable": true }, "Basic_Auth": { "$ref": "#/components/schemas/Basic_Auth", "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request.", "nullable": true }, "Bearer_Token": { "type": "string", "description": "Bearer tokens enable requests to authenticate using an access key.", "nullable": true }, "No_Auth": { "type": "string", "description": "No authorization. If your request doesn't require authorization.", "nullable": true } }, "description": "Authorization type for the custom action." }, "API_Key": { "type": "object", "properties": { "key": { "type": "string", "description": "Enter your key name", "nullable": true }, "value": { "type": "string", "description": "Enter you key value", "nullable": true } }, "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters." }, "Basic_Auth": { "type": "object", "properties": { "password": { "type": "string", "description": "Password for the basic authentication", "nullable": true }, "username": { "type": "string", "description": "Username for the basic authentication", "nullable": true } }, "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request." }, "ParametersListItem": { "type": "object", "properties": { "key": { "type": "string", "description": "Key for the url query parameter", "nullable": true }, "value": { "type": "string", "description": "Value for the url query parameter", "nullable": true } } }, "Default_action_config": { "type": "object", "properties": { "visibility": { "type": "boolean", "description": "Custom action is available on all visualizations. Earlier , the naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.", "nullable": true } }, "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers." }, "Metadata_Association_Item": { "type": "object", "required": [ "action_config", "identifier", "type" ], "properties": { "action_config": { "$ref": "#/components/schemas/Action_config", "description": "Specify that the association is enabled for the metadata object" }, "identifier": { "type": "string", "description": "Unique ID or name of the metadata." }, "type": { "type": "string", "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier." } } }, "Action_config": { "type": "object", "properties": { "position": { "type": "string", "description": "Position of the Custom action on the Metadata object. Earlier naming convention: context.", "nullable": true }, "visibility": { "type": "boolean", "description": "Visibility of the metadata association with custom action. Earlier naming convention: enabled", "nullable": true } }, "description": "Specify that the association is enabled for the metadata object" }, "CustomActionMetadataTypeInput": { "type": "object", "required": [ "identifier" ], "properties": { "type": { "type": "string", "enum": [ "VISUALIZATION", "ANSWER", "WORKSHEET" ], "description": " Type of metadata object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.", "nullable": true }, "identifier": { "type": "string", "description": "Unique ID or name of the metadata object." } }, "description": "MetadataType InputType used in Custom Action API's" }, "MetadataContext": { "type": "object", "properties": { "data_source_identifiers": { "type": "array", "items": { "type": "string" }, "description": "List of data_source_identifiers to provide context for breaking down user query into analytical queries that can be run on them.", "nullable": true }, "answer_identifiers": { "type": "array", "items": { "type": "string" }, "description": "List of answer unique identifiers (GUIDs) whose data will be used to guide the response.", "nullable": true }, "conversation_identifier": { "type": "string", "description": "Unique identifier to denote current conversation.", "nullable": true }, "liveboard_identifiers": { "type": "array", "items": { "type": "string" }, "description": "List of liveboard unique identifiers (GUIDs) whose data will be used to guide the response.", "nullable": true } } }, "AIContext": { "type": "object", "properties": { "instructions": { "type": "array", "items": { "type": "string" }, "description": "User specific text instructions sent to AI system for processing the query.", "nullable": true }, "content": { "type": "array", "items": { "type": "string" }, "description": "User provided content like text data, csv data as a string message to provide context & potentially improve the quality of the response.", "nullable": true } } }, "eureka_GetRelevantQuestionsResponse": { "type": "object", "properties": { "relevant_questions": { "type": "array", "items": { "$ref": "#/components/schemas/eureka_RelevantQuestion" }, "description": "List of relevant questions that can be run on their respective data sources.", "nullable": true } } }, "eureka_RelevantQuestion": { "type": "object", "properties": { "query": { "type": "string", "description": "NL query that can be run using spotter aka natural language search to get an AI generated answer.", "nullable": true }, "data_source_identifier": { "type": "string", "description": "Unique identifier of the data source on which this query can be run on.", "nullable": true }, "data_source_name": { "type": "string", "description": "Display name of the data source on which this query can be run on.", "nullable": true } } }, "Input_eureka_NLSRequest": { "type": "object", "properties": { "agentVersion": { "type": "integer", "format": "int32", "description": "Cluster version like 10.4.0.cl, 10.5.0.cl, so on.", "nullable": true }, "bypassCache": { "type": "boolean", "description": "If true, results are not returned from cache & calculated every time. Can incur high costs & latency.", "nullable": true }, "instructions": { "type": "array", "items": { "type": "string" }, "description": "User specific instructions for processing the @query.", "nullable": true }, "query": { "type": "string", "description": "User query which is a topical/goal oriented question that needs to be broken down into smaller simple analytical questions.", "nullable": true } } }, "eureka_DecomposeQueryResponse": { "type": "object", "properties": { "decomposedQueryResponse": { "$ref": "#/components/schemas/eureka_LLMDecomposeQueryResponse", "description": "Decomposed query response for a topical/goal oriented question that contains broken down analytical questions.", "nullable": true } } }, "eureka_LLMDecomposeQueryResponse": { "type": "object", "properties": { "decomposedQueries": { "type": "array", "items": { "$ref": "#/components/schemas/eureka_LLMSuggestedQuery" }, "description": "List of analytical questions that can be run on their respective worksheet/data sources.", "nullable": true } } }, "eureka_LLMSuggestedQuery": { "type": "object", "properties": { "query": { "type": "string", "description": "NL query that can be run using spotter aka natural language search to get an AI generated answer.", "nullable": true }, "worksheetId": { "type": "string", "description": "Unique identifier of the worksheet on which this query can be run on.", "nullable": true }, "worksheetName": { "type": "string", "description": "Display name of the worksheet on which this query can be run on.", "nullable": true } } }, "eureka_DataSourceSuggestionResponse": { "type": "object", "properties": { "data_sources": { "type": "array", "items": { "$ref": "#/components/schemas/DataSource" }, "description": "List of data sources suggested.", "nullable": true } } }, "DataSource": { "type": "object", "properties": { "confidence": { "type": "number", "format": "float", "description": "Confidence score for the data source suggestion.", "nullable": true }, "details": { "$ref": "#/components/schemas/EntityHeader", "description": "Details of the data source.", "nullable": true }, "reasoning": { "type": "string", "description": "LLM reasoning for the data source.", "nullable": true } } }, "EntityHeader": { "type": "object", "properties": { "description": { "type": "string", "description": "Description of the data source.", "nullable": true }, "data_source_name": { "type": "string", "description": "Display name of the data source.", "nullable": true }, "data_source_identifier": { "type": "string", "description": "Unique identifier of the data source.", "nullable": true } } }, "eureka_GetNLInstructionsResponse": { "type": "object", "required": [ "nl_instructions_info" ], "properties": { "nl_instructions_info": { "type": "array", "items": { "$ref": "#/components/schemas/NLInstructionsInfo" }, "description": "List of NL instructions with their scopes." } } }, "NLInstructionsInfo": { "type": "object", "required": [ "instructions", "scope" ], "properties": { "instructions": { "type": "array", "items": { "type": "string" }, "description": "User instructions for natural language processing." }, "scope": { "type": "string", "enum": [ "GLOBAL" ], "description": "Scope of the instruction." } } }, "AgentInstructions": { "type": "object", "required": [ "instructions" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the record.", "nullable": true }, "instructions": { "type": "string", "description": "The admin instructions text for the agent." }, "created_at": { "type": "string", "description": "ISO timestamp when the instructions were created.", "nullable": true }, "updated_at": { "type": "string", "description": "ISO timestamp when the instructions were last updated.", "nullable": true }, "last_updated_by": { "type": "string", "description": "User ID of the admin who last updated the instructions.", "nullable": true } }, "description": "Admin instructions configured for the AI agent." }, "AgentConversationHistoryResponse": { "type": "object", "properties": { "conversations": { "type": "array", "items": { "$ref": "#/components/schemas/AgentConversationList" }, "description": "List of saved agent conversations for the current user.", "nullable": true }, "has_more": { "type": "boolean", "description": "Whether additional conversations exist beyond this page. `true` when one or\nmore conversations remain after the current page; `false` when the current\npage is the last. Use `offset` to fetch the next page.", "nullable": true } }, "description": "Response returned by getConversationList." }, "AgentConversationList": { "type": "object", "required": [ "conversation_identifier" ], "properties": { "conversation_identifier": { "type": "string", "description": "Unique identifier of the conversation." }, "conversation_title": { "type": "string", "description": "Display title of the conversation.", "nullable": true }, "created_at": { "type": "string", "description": "ISO 8601 timestamp when the conversation was created.", "nullable": true }, "updated_at": { "type": "string", "description": "ISO 8601 timestamp when the conversation was last updated.", "nullable": true }, "data_source_identifiers": { "type": "array", "items": { "type": "string" }, "description": "Unique identifiers of the data sources associated with the conversation.", "nullable": true }, "data_source_names": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourceEntry" }, "description": "Data sources associated with the conversation, each with an `id` and `name`.", "nullable": true }, "is_pinned": { "type": "boolean", "description": "Whether the current user has pinned this conversation. Pinned\nconversations are surfaced first in the list.
Version: 26.10.0.cl or later", "nullable": true }, "analyst_id": { "type": "string", "description": "Unique identifier of the Spotter Analyst the conversation is associated\nwith. Null when the conversation is not associated with an analyst.
Version: 26.10.0.cl or later", "nullable": true } }, "description": "A saved agent conversation item returned in list responses." }, "DataSourceEntry": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the data source." }, "name": { "type": "string", "description": "Display name of the data source." } }, "description": "A data source associated with a conversation, returned as a typed entry." }, "ConversationMessageResponse": { "type": "object", "properties": { "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationMessage" }, "description": "Ordered conversation messages. Empty array when the conversation has no messages.", "nullable": true }, "code_execution_files": { "type": "array", "items": { "$ref": "#/components/schemas/CodeExecutionFileMetadata" }, "description": "Sanitized code-execution file metadata for files referenced by this\nconversation. Empty array when the conversation has no code-execution files.", "nullable": true } }, "description": "Response body of getConversation. `messages` is ordered oldest to newest.\n`code_execution_files` is a list of sanitized code-execution file metadata\nentries, keyed in upstream by `file_id`." }, "ConversationMessage": { "type": "object", "required": [ "message_id", "timestamp_in_millis" ], "properties": { "message_id": { "type": "string", "description": "Stable identifier for the turn. For liveboard-started synthetic first turns,\nthis is the root node identifier." }, "timestamp_in_millis": { "type": "object", "description": "Milliseconds since Unix epoch for the turn." }, "user_prompt": { "$ref": "#/components/schemas/UserPrompt", "description": "User-authored prompt that started the turn: the user's message and any files\nor connector resources attached to it. Null for liveboard-started synthetic\nfirst turns.", "nullable": true }, "response_items": { "type": "array", "items": { "type": "object" }, "description": "Agent-side output produced in response to this turn. Empty array for\nin-progress turns where the agent has not yet produced output.", "nullable": true } }, "description": "One conversational exchange: an optional user prompt (message and attachments),\nfollowed by the agent's response items for that turn." }, "UserPrompt": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/UserMessage", "description": "User query that started the turn. Null for liveboard-started synthetic first turns.", "nullable": true }, "attachments": { "type": "array", "items": { "type": "object" }, "description": "Files or connector resources attached to the user message. Empty array when\nthere are no attachments.", "nullable": true } }, "description": "User-authored prompt for a conversation turn: the user's text message and any\nfiles or connector resources attached to it." }, "UserMessage": { "type": "object", "required": [ "message_id", "content" ], "properties": { "message_id": { "type": "string", "description": "Unique identifier of the user message." }, "content": { "type": "string", "description": "Text body of the user query." } }, "description": "User-authored text message that begins a conversation turn.\nNull when the turn is a synthetic liveboard-started first turn." }, "FileResponseItem": { "type": "object", "required": [ "type", "timestamp_in_millis" ], "properties": { "type": { "type": "string", "description": "Variant discriminator. Always `\"file\"`." }, "timestamp_in_millis": { "type": "object", "description": "Milliseconds since Unix epoch when this item was produced." }, "is_thinking": { "type": "boolean", "description": "True when the item represents internal agent reasoning rather than user-facing output.", "nullable": true }, "step_title": { "type": "string", "description": "Human-readable label for the agent step producing this item.", "nullable": true }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/PublicFileInfo" }, "description": "Sanitized file metadata.", "nullable": true } }, "description": "Uploaded or generated files attached to a turn." }, "PublicFileInfo": { "type": "object", "required": [ "file_id" ], "properties": { "file_id": { "type": "string", "description": "Unique identifier of the file." }, "display_name": { "type": "string", "description": "Human-readable file name.", "nullable": true }, "file_type": { "type": "string", "description": "File type such as `csv`, `pdf`, or `png`.", "nullable": true }, "created_time_in_millis": { "type": "object", "description": "Milliseconds since Unix epoch when the file was created.", "nullable": true }, "size_bytes": { "type": "integer", "format": "int32", "description": "File size in bytes.", "nullable": true } }, "description": "Sanitized metadata for a file attached to or produced by a conversation turn.\nNever exposes internal Azure or blob-storage identifiers." }, "ResourceResponseItem": { "type": "object", "required": [ "type", "timestamp_in_millis", "title", "uri" ], "properties": { "type": { "type": "string", "description": "Variant discriminator. Always `\"resource\"`." }, "timestamp_in_millis": { "type": "object", "description": "Milliseconds since Unix epoch when this item was produced." }, "is_thinking": { "type": "boolean", "description": "True when the item represents internal agent reasoning rather than user-facing output.", "nullable": true }, "step_title": { "type": "string", "description": "Human-readable label for the agent step producing this item.", "nullable": true }, "title": { "type": "string", "description": "Human-readable title of the resource." }, "uri": { "type": "string", "description": "Resource URI." }, "name": { "type": "string", "description": "Original name or filename.", "nullable": true }, "mime_type": { "type": "string", "description": "MIME type.", "nullable": true }, "description": { "type": "string", "description": "Short description.", "nullable": true }, "size": { "type": "integer", "format": "int32", "description": "Size in bytes.", "nullable": true }, "connector_id": { "type": "string", "description": "Connector instance identifier.", "nullable": true }, "connector_name": { "type": "string", "description": "Human-readable connector name.", "nullable": true }, "connector_slug": { "type": "string", "description": "Connector slug or type key.", "nullable": true }, "transport_type": { "type": "string", "enum": [ "STREAMABLE_HTTP", "SSE" ], "description": "Underlying transport protocol used by the MCP connector. See `TransportType`\nfor accepted values.", "nullable": true } }, "description": "MCP (Model Context Protocol) resource — typically a connector-provided artifact\nsuch as a document excerpt." }, "TextResponseItem": { "type": "object", "required": [ "type", "timestamp_in_millis", "content" ], "properties": { "type": { "type": "string", "description": "Variant discriminator. Always `\"text\"`." }, "timestamp_in_millis": { "type": "object", "description": "Milliseconds since Unix epoch when this item was produced." }, "is_thinking": { "type": "boolean", "description": "True when the item represents internal agent reasoning rather than user-facing output.", "nullable": true }, "step_title": { "type": "string", "description": "Human-readable label for the agent step producing this item.", "nullable": true }, "content": { "type": "string", "description": "The text body." }, "content_type": { "type": "string", "enum": [ "TEXT_PLAIN", "TEXT_MARKDOWN", "TEXT_X_MARKDOWN_WITH_CODE", "TEXT_HTML" ], "description": "Rendering hint for the text content. See `ContentMimeType` for accepted values.", "nullable": true }, "file_reference": { "$ref": "#/components/schemas/FileReference", "description": "Pointer to a code-execution-generated file associated with this text item.", "nullable": true } }, "description": "Agent text output." }, "FileReference": { "type": "object", "required": [ "file_id" ], "properties": { "file_id": { "type": "string", "description": "Unique identifier of the code-execution-generated file." }, "display_name": { "type": "string", "description": "Human-readable file name.", "nullable": true }, "created_time_in_millis": { "type": "object", "description": "Milliseconds since Unix epoch when the file was created.", "nullable": true } }, "description": "Pointer to a code-execution-generated file referenced from a text response item.\nFull metadata (including expiry) is in the top-level `code_execution_files` map." }, "ToolCallResponseItem": { "type": "object", "required": [ "type", "timestamp_in_millis", "arguments" ], "properties": { "type": { "type": "string", "description": "Variant discriminator. Always `\"tool_call\"`." }, "timestamp_in_millis": { "type": "object", "description": "Milliseconds since Unix epoch when this item was produced." }, "is_thinking": { "type": "boolean", "description": "True when the item represents internal agent reasoning rather than user-facing output.", "nullable": true }, "step_title": { "type": "string", "description": "Human-readable label for the agent step producing this item.", "nullable": true }, "tool_call_id": { "type": "string", "description": "Identifier linking this tool call to its matching tool_result or answer.", "nullable": true }, "tool_name": { "type": "string", "description": "Name of the tool being invoked.", "nullable": true }, "arguments": { "type": "object", "description": "Input arguments passed to the tool. Shape depends on the tool." } }, "description": "Agent invoked a tool." }, "ToolResultResponseItem": { "type": "object", "required": [ "type", "timestamp_in_millis", "content" ], "properties": { "type": { "type": "string", "description": "Variant discriminator. Always `\"tool_result\"`." }, "timestamp_in_millis": { "type": "object", "description": "Milliseconds since Unix epoch when this item was produced." }, "is_thinking": { "type": "boolean", "description": "True when the item represents internal agent reasoning rather than user-facing output.", "nullable": true }, "step_title": { "type": "string", "description": "Human-readable label for the agent step producing this item.", "nullable": true }, "tool_call_id": { "type": "string", "description": "Matches the originating tool_call.", "nullable": true }, "tool_name": { "type": "string", "description": "Name of the tool that produced this result.", "nullable": true }, "content": { "type": "string", "description": "Result body (tool output, or `\": \"` for errors)." }, "content_type": { "type": "string", "enum": [ "TEXT_PLAIN", "TEXT_MARKDOWN", "TEXT_X_MARKDOWN_WITH_CODE", "TEXT_HTML" ], "description": "Rendering hint for the result content; defaults to `TEXT_PLAIN` for tool\nresults. See `ContentMimeType` for accepted values.", "nullable": true }, "success": { "type": "boolean", "description": "False when the tool invocation errored; true otherwise.", "nullable": true } }, "description": "Result returned from a tool invocation." }, "AnswerResponseItem": { "type": "object", "required": [ "type", "timestamp_in_millis", "answer_id" ], "properties": { "type": { "type": "string", "description": "Variant discriminator. Always `\"answer\"`." }, "timestamp_in_millis": { "type": "object", "description": "Milliseconds since Unix epoch when this item was produced." }, "is_thinking": { "type": "boolean", "description": "True when the item represents internal agent reasoning rather than user-facing output.", "nullable": true }, "step_title": { "type": "string", "description": "Human-readable label for the agent step producing this item.", "nullable": true }, "answer_id": { "type": "string", "description": "Identifier used to fetch the full answer payload separately." }, "tool_call_id": { "type": "string", "description": "Links to the originating tool_call, when applicable.", "nullable": true }, "tool_name": { "type": "string", "description": "Tool that produced the answer, when applicable.", "nullable": true } }, "description": "Slim reference to a saved answer produced by the agent. Full answer payload\n(visualization spec, formulas, session info) is not embedded — fetch separately\nvia `loadAnswer` using `answer_id`." }, "SearchDatasetsResponseItem": { "type": "object", "required": [ "type", "timestamp_in_millis", "text" ], "properties": { "type": { "type": "string", "description": "Variant discriminator. Always `\"search_datasets\"`." }, "timestamp_in_millis": { "type": "object", "description": "Milliseconds since Unix epoch when this item was produced." }, "is_thinking": { "type": "boolean", "description": "True when the item represents internal agent reasoning rather than user-facing output.", "nullable": true }, "step_title": { "type": "string", "description": "Human-readable label for the agent step producing this item.", "nullable": true }, "text": { "type": "string", "description": "Summary message describing the dataset search results." }, "data_sources": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourceInfo" }, "description": "Dataset descriptors returned by the `search_datasets` tool.", "nullable": true } }, "description": "Result of a dataset discovery step." }, "DataSourceInfo": { "type": "object", "properties": { "data_source_identifier": { "type": "string", "description": "Unique identifier of the data source (mirrors `header.guid`).", "nullable": true }, "data_source_name": { "type": "string", "description": "Display name of the data source (mirrors `header.display_name`).", "nullable": true }, "description": { "type": "string", "description": "Optional description of the data source.", "nullable": true }, "confidence": { "type": "number", "format": "float", "description": "Tool-reported confidence that this data source matches the query, in `[0, 1]`.", "nullable": true }, "reasoning": { "type": "string", "description": "LLM reasoning describing why the data source was selected.", "nullable": true }, "header": { "$ref": "#/components/schemas/DataSourceHeader", "description": "Header metadata extracted from the data source proto.", "nullable": true }, "related_liveboard_visualizations": { "type": "array", "items": { "type": "object" }, "description": "Related liveboard visualizations for this data source. Open-ended JSON shape\ndriven by the underlying proto.", "nullable": true }, "related_answers": { "type": "array", "items": { "type": "object" }, "description": "Related saved answers for this data source. Open-ended JSON shape driven by\nthe underlying proto.", "nullable": true }, "related_spotter_queries": { "type": "array", "items": { "type": "string" }, "description": "Related Spotter queries previously run against this data source. Truncated to\na small upper bound by the tool.", "nullable": true }, "popularity": { "$ref": "#/components/schemas/DataSourcePopularity", "description": "Aggregate popularity counters.", "nullable": true }, "user_usage": { "$ref": "#/components/schemas/DataSourceUserUsage", "description": "Per-user usage counters scoped to the calling user.", "nullable": true } }, "description": "A data source descriptor returned by the agent's `search_datasets` tool." }, "DataSourceHeader": { "type": "object", "properties": { "display_name": { "type": "string", "description": "Display name of the data source.", "nullable": true }, "guid": { "type": "string", "description": "Canonical unique identifier (GUID) of the data source.", "nullable": true }, "description": { "type": "string", "description": "Optional description of the data source.", "nullable": true } }, "description": "Header metadata extracted from a data source proto. `guid` is the canonical\ndata source identifier and `display_name` is its user-facing name." }, "DataSourcePopularity": { "type": "object", "properties": { "total_spotter_queries": { "type": "integer", "format": "int32", "description": "Total number of Spotter natural-language queries run against this data source.", "nullable": true }, "total_answers": { "type": "integer", "format": "int32", "description": "Total number of saved answers backed by this data source.", "nullable": true }, "total_answer_impressions": { "type": "integer", "format": "int32", "description": "Total number of impressions across saved answers backed by this data source.", "nullable": true } }, "description": "Aggregate popularity counters for a data source." }, "DataSourceUserUsage": { "type": "object", "properties": { "total_spotter_queries": { "type": "integer", "format": "int32", "description": "Total Spotter natural-language queries the calling user has run against this\ndata source.", "nullable": true } }, "description": "Per-user usage counters for a data source, scoped to the calling user." }, "CodeExecutionFileMetadata": { "type": "object", "required": [ "file_id", "expired" ], "properties": { "file_id": { "type": "string", "description": "Unique identifier of the code-execution-generated file. Stable across\nconversation turns." }, "display_name": { "type": "string", "description": "Human-readable file name.", "nullable": true }, "file_type": { "type": "string", "description": "File type hint. Either a MIME string (e.g. `text/csv`) or an extension\n(e.g. `csv`).", "nullable": true }, "created_time_in_millis": { "type": "object", "description": "Milliseconds since Unix epoch when the file was created.", "nullable": true }, "expired": { "type": "boolean", "description": "True when the file is no longer downloadable (storage expired or evicted)." } }, "description": "Sanitized public metadata for a code-execution-generated file. Internal\nstorage identifiers (e.g. Azure blob ids) are deliberately not exposed." }, "LoadAnswerResponse": { "type": "object", "properties": { "answer": { "$ref": "#/components/schemas/AnswerDetails", "description": "Answer details for the loaded message.", "nullable": true } } }, "AnswerDetails": { "type": "object", "properties": { "title": { "type": "string", "description": "Display title of the answer.", "nullable": true }, "description": { "type": "string", "description": "Description of the answer.", "nullable": true }, "session_identifier": { "type": "string", "description": "Unique identifier of the session.", "nullable": true }, "generation_number": { "type": "integer", "format": "int32", "description": "Generation number of the answer.", "nullable": true }, "tokens": { "type": "array", "items": { "type": "string" }, "description": "Ordered list of TML token strings that make up the answer query.", "nullable": true }, "visualization_type": { "type": "string", "enum": [ "Chart", "CHART", "Table", "TABLE", "Undefined", "UNDEFINED" ], "description": "Visualization type for the answer.", "nullable": true }, "formulas": { "type": "array", "items": { "type": "string" }, "description": "List of formulas used in the answer.", "nullable": true }, "parameters": { "type": "array", "items": { "type": "string" }, "description": "List of parameters used in the answer.", "nullable": true }, "sub_queries": { "type": "array", "items": { "type": "object" }, "description": "List of sub-queries used in the answer.", "nullable": true }, "ac_state": { "$ref": "#/components/schemas/ACState", "description": "Agent context state for the answer.", "nullable": true } } }, "ACState": { "type": "object", "properties": { "transaction_identifier": { "type": "string", "description": "Unique identifier of the transaction.", "nullable": true }, "generation_number": { "type": "integer", "format": "int32", "description": "Generation number of the transaction.", "nullable": true } } }, "ConversationShareStatusResponse": { "type": "object", "required": [ "conversation_id", "principals" ], "properties": { "conversation_id": { "type": "string", "description": "Unique identifier of the source conversation." }, "is_shared_content_outdated": { "type": "boolean", "description": "`true` when the shared view was generated before the last edit to the\nconversation and does not reflect the latest content. `null` when the\nconversation has never been shared.", "nullable": true }, "principals": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationPrincipalInfo" }, "description": "List of principals that currently have access to this shared conversation.\nEmpty when no principals have been granted access." } }, "description": "Response returned by getShareInfo." }, "ConversationPrincipalInfo": { "type": "object", "required": [ "id", "type", "display_name", "name", "permission" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the user or group." }, "type": { "type": "string", "enum": [ "USER", "USER_GROUP" ], "description": "Whether the principal is an individual user or a group." }, "display_name": { "type": "string", "description": "Display name of the principal as shown in the UI." }, "name": { "type": "string", "description": "Internal name of the principal." }, "permission": { "type": "string", "enum": [ "READ_ONLY", "MODIFY", "NO_ACCESS" ], "description": "Access level granted to the principal. Always `READ_ONLY` for shared conversations." } }, "description": "A principal that has been granted access to a shared conversation." }, "SharedConversationResponse": { "type": "object", "required": [ "conversation_id", "shared_conversation_id", "data_sources", "analyst_ids", "messages", "code_execution_files" ], "properties": { "conversation_id": { "type": "string", "description": "Unique identifier of the source conversation (echoes the request parameter)." }, "shared_conversation_id": { "type": "string", "description": "Identifier for the shared view. Use this as `conversation_identifier` in\nfollow-up `loadAnswer` calls to hydrate answer items in the messages." }, "conversation_title": { "type": "string", "description": "Display title of the conversation.", "nullable": true }, "creator_user_id": { "type": "string", "description": "Identifier of the user who created the conversation and shared it. This is\nthe original creator, not the caller retrieving the shared content.", "nullable": true }, "data_sources": { "type": "array", "items": { "$ref": "#/components/schemas/DataSourceEntry" }, "description": "Data sources used by the conversation, each with an identifier and display name." }, "analyst_ids": { "type": "array", "items": { "type": "string" }, "description": "Identifiers of the AI analysts the conversation ran against. An analyst is a\npurpose-built agent configured over a set of data sources, with its own\ninstructions and access rules. Empty array when the conversation is not\nassociated with any analyst; never null." }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationMessage" }, "description": "Ordered conversation messages, oldest to newest. Same structure as the\n`messages` field returned by `getConversation`. Empty array when the\nconversation has no messages; never null." }, "code_execution_files": { "type": "array", "items": { "$ref": "#/components/schemas/CodeExecutionFileMetadata" }, "description": "Sanitized metadata for files generated by the code-execution tool during\nthis conversation. Empty when there are no such files." } }, "description": "Response returned by getSharedContent. Contains the full read-only view\nof the shared conversation including messages and data source metadata." }, "RiseGQLArgWrapper": { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": { "type": "string" } } }, "MemorySources": { "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "type": "string", "enum": [ "DATA_MODEL" ], "description": "Source object type for this group. Must be `DATA_MODEL`." }, "identifiers": { "type": "array", "items": { "type": "string" }, "description": "Data-models to export memory for. Each entry may be a GUID or a\nhuman-readable obj_id; obj_ids are resolved server-side." } }, "description": "A single typed scope group identifying objects whose memory entries\nshould be exported. One group binds a single `type` to a set of\n`identifiers`; pass one or more data-model identifiers in a group to\nscope the memory export to multiple data-models in one call." }, "ExportMemoryResponse": { "type": "object", "properties": { "content": { "type": "string", "description": "Serialized memory payload (YAML). This is the shape\nimportMemory consumes.", "nullable": true } }, "description": "Response from exportMemory. Contains the serialized payload\nready for local editing and re-submission to importMemory." }, "VariableDetailInput": { "type": "object", "properties": { "identifier": { "type": "string", "description": "Unique ID, name, or object ID of the variable", "nullable": true }, "type": { "type": "string", "enum": [ "CONNECTION_PROPERTY", "TABLE_MAPPING", "CONNECTION_PROPERTY_PER_PRINCIPAL", "FORMULA_VARIABLE", "USER_PROPERTY" ], "description": "Type of variable", "nullable": true }, "name_pattern": { "type": "string", "description": "A pattern to match case-insensitive name of the variable. User % for a wildcard match", "nullable": true } }, "description": "Input for variable details in search" }, "ValueScopeInput": { "type": "object", "properties": { "org_identifier": { "type": "string", "description": "The unique name of the org", "nullable": true }, "principal_type": { "type": "string", "enum": [ "USER", "USER_GROUP" ], "description": "Type of principal to filter by. Use USER to filter values assigned to specific users, or USER_GROUP to filter values assigned to groups.", "nullable": true }, "principal_identifier": { "type": "string", "description": "Unique ID or name of the principal", "nullable": true }, "model_identifier": { "type": "string", "description": "Unique ID or name of the model to filter by. Applicable only for FORMULA_VARIABLE type.", "nullable": true } }, "description": "Input for filtering variable values by scope in search operations" }, "Variable": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the variable" }, "name": { "type": "string", "description": "Name of the variable" }, "obj_id": { "type": "string", "description": "Custom object identifier (obj_id) of the variable
Version: 26.10.0.cl or later", "nullable": true }, "variable_type": { "type": "string", "enum": [ "CONNECTION_PROPERTY", "TABLE_MAPPING", "CONNECTION_PROPERTY_PER_PRINCIPAL", "FORMULA_VARIABLE", "USER_PROPERTY" ], "description": "Type of the variable", "nullable": true }, "sensitive": { "type": "boolean", "description": "If the variable is sensitive", "nullable": true }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/VariableValue" }, "description": "Values of the variable", "nullable": true }, "org": { "$ref": "#/components/schemas/VariableOrgInfo", "description": "Owner org of the variable.", "nullable": true } }, "description": "Variable object" }, "VariableValue": { "type": "object", "required": [ "org_identifier" ], "properties": { "value": { "type": "string", "description": "The value of the variable", "nullable": true }, "value_list": { "type": "array", "items": { "type": "string" }, "description": "The value of the variable if it is a list type", "nullable": true }, "org_identifier": { "type": "string", "description": "The unique name of the org" }, "principal_type": { "type": "string", "enum": [ "USER", "USER_GROUP" ], "description": "Type of principal to which this value applies. Use USER to assign the value to a specific user, or USER_GROUP to assign it to a group.", "nullable": true }, "principal_identifier": { "type": "string", "description": "Unique ID or name of the principal", "nullable": true }, "model_identifier": { "type": "string", "description": "Unique ID of the model
Beta Version: 26.3.0.cl or later", "nullable": true }, "priority": { "type": "integer", "format": "int32", "description": "The priority assigned to this value. If there are 2 matching values, the one with the higher priority will be picked.", "nullable": true } } }, "VariableOrgInfo": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int32", "description": "ID of the Org." }, "name": { "type": "string", "description": "Name of the Org." } } }, "SortOption": { "type": "object", "properties": { "field_name": { "type": "string", "enum": [ "DEFAULT", "NAME", "DISPLAY_NAME", "AUTHOR", "CREATED", "MODIFIED" ], "default": "DEFAULT", "description": "Name of the field to apply the sort on.", "nullable": true }, "order": { "type": "string", "enum": [ "ASC", "DESC" ], "default": "ASC", "description": "Sort order : ASC(Ascending) or DESC(Descending).", "nullable": true } } }, "CalendarResponse": { "type": "object", "properties": { "calendar_name": { "type": "string", "description": "Name of the calendar", "nullable": true }, "connection_name": { "type": "string", "description": "Name of the connection", "nullable": true }, "data_warehouse_type": { "type": "string", "description": "Type of data warehouse", "nullable": true }, "modification_time_in_millis": { "type": "string", "description": "Last modification time in milliseconds", "nullable": true }, "author_name": { "type": "string", "description": "Name of the author who created the calendar", "nullable": true }, "connection_id": { "type": "string", "description": "Unique ID of the connection", "nullable": true }, "calendar_id": { "type": "string", "description": "Unique ID of the calendar", "nullable": true } } }, "ConnectionConfigurationResponse": { "type": "object", "properties": { "configuration_identifier": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "configuration": { "type": "object", "nullable": true }, "policy_principals": { "type": "array", "items": { "$ref": "#/components/schemas/UserPrincipal" }, "nullable": true }, "policy_processes": { "type": "array", "items": { "type": "string", "enum": [ "SAGE_INDEXING", "ROW_COUNT_STATS", "SCHEDULED_LIVEBOARDS" ] }, "nullable": true }, "disabled": { "type": "boolean", "nullable": true }, "data_warehouse_type": { "type": "string", "enum": [ "SNOWFLAKE", "AMAZON_REDSHIFT", "GOOGLE_BIGQUERY", "AZURE_SYNAPSE", "TERADATA", "SAP_HANA", "STARBURST", "ORACLE_ADW", "DATABRICKS", "DENODO", "DREMIO", "TRINO", "PRESTO", "POSTGRES", "SQLSERVER", "MYSQL", "GENERIC_JDBC", "AMAZON_RDS_POSTGRESQL", "AMAZON_AURORA_POSTGRESQL", "AMAZON_RDS_MYSQL", "AMAZON_AURORA_MYSQL", "LOOKER", "AMAZON_ATHENA", "SINGLESTORE", "GCP_SQLSERVER", "GCP_ALLOYDB_POSTGRESQL", "GCP_POSTGRESQL", "GCP_MYSQL", "MODE", "GOOGLE_SHEETS", "FALCON", "FALCON_ONPREM", "CLICKHOUSE", "IOMETE" ], "nullable": true }, "policy_type": { "type": "string", "enum": [ "NO_POLICY", "PRINCIPALS", "PROCESSES" ], "nullable": true }, "same_as_parent": { "type": "boolean", "nullable": true }, "policy_process_options": { "$ref": "#/components/schemas/PolicyProcessOptions", "nullable": true } } }, "UserPrincipal": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } } }, "PolicyProcessOptions": { "type": "object", "properties": { "impersonate_user": { "type": "string", "nullable": true } } }, "WebhookStorageConfigInfo": { "type": "object", "required": [ "storage_type", "provider", "config" ], "properties": { "storage_type": { "type": "string", "enum": [ "OBJECT_STORAGE" ], "description": "Type of storage destination." }, "provider": { "type": "string", "enum": [ "AWS_S3", "GCP_GCS" ], "description": "Storage destination provider." }, "config": { "$ref": "#/components/schemas/WebhookStorageSetupConfig", "description": "Setup configuration specific to the upload path." } }, "description": "Cluster-level storage setup information for configuring customer-managed storage." }, "WebhookStorageSetupConfig": { "type": "object", "required": [ "config_type", "setup_instructions" ], "properties": { "config_type": { "type": "string", "enum": [ "AWS_TO_S3_STORAGE", "GCP_TO_S3_STORAGE", "GCP_TO_GCS_STORAGE" ], "description": "Discriminator identifying the upload path. One of: AWS_TO_S3_STORAGE, GCP_TO_S3_STORAGE, GCP_TO_GCS_STORAGE." }, "aws_account_id": { "type": "string", "description": "AWS Account ID of the platform. Populated for AWS_TO_S3_STORAGE. Include in your IAM role trust policy.", "nullable": true }, "gcp_service_account_id": { "type": "string", "description": "GCP service account numeric ID of the platform (the 'sub' claim in OIDC tokens). Populated for GCP_TO_S3_STORAGE.", "nullable": true }, "oidc_provider": { "type": "string", "description": "OIDC identity provider URL. Populated for GCP_TO_S3_STORAGE; always 'accounts.google.com' for GCP.", "nullable": true }, "trust_policy_template": { "type": "object", "description": "Sample IAM trust policy JSON. Populated for AWS_TO_S3_STORAGE and GCP_TO_S3_STORAGE.", "nullable": true }, "service_account_email": { "type": "string", "description": "GCP service account email of the platform. Populated for GCP_TO_GCS_STORAGE. Grant it roles/iam.serviceAccountTokenCreator on your service account.", "nullable": true }, "required_role": { "type": "string", "description": "IAM role the customer must grant to the platform service account. Populated for GCP_TO_GCS_STORAGE.", "nullable": true }, "setup_instructions": { "type": "array", "items": { "type": "string" }, "description": "Step-by-step instructions to configure the storage destination." } }, "description": "Storage setup configuration for a specific upload path. The populated fields depend on config_type:\nAWS_TO_S3_STORAGE: aws_account_id, trust_policy_template, setup_instructions.\nGCP_TO_S3_STORAGE: gcp_service_account_id, oidc_provider, trust_policy_template, setup_instructions.\nGCP_TO_GCS_STORAGE: service_account_email, required_role, setup_instructions." }, "WebhookSortOptionsInput": { "type": "object", "properties": { "field_name": { "type": "string", "enum": [ "CREATED", "MODIFIED", "NAME" ], "default": "CREATED", "description": "Name of the field to apply the sort on.", "nullable": true }, "order": { "type": "string", "enum": [ "ASC", "DESC" ], "default": "DESC", "description": "Sort order: ASC (Ascending) or DESC (Descending).", "nullable": true } } }, "WebhookSearchResponse": { "type": "object", "required": [ "webhooks", "pagination" ], "properties": { "webhooks": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookResponse" }, "description": "List of webhook configurations matching the search criteria." }, "pagination": { "$ref": "#/components/schemas/WebhookPagination", "description": "Pagination information." } } }, "WebhookResponse": { "type": "object", "required": [ "id", "name", "url", "events", "creation_time_in_millis", "modification_time_in_millis" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the webhook configuration." }, "name": { "type": "string", "description": "Name of the webhook configuration." }, "description": { "type": "string", "description": "Description of the webhook configuration.", "nullable": true }, "org": { "$ref": "#/components/schemas/WebhookOrg", "description": "Org details.", "nullable": true }, "url": { "type": "string", "description": "The webhook endpoint URL." }, "url_params": { "type": "object", "description": "Additional URL parameters as key-value pairs.", "nullable": true }, "events": { "type": "array", "items": { "type": "string", "enum": [ "LIVEBOARD_SCHEDULE" ] }, "description": "List of events this webhook subscribes to." }, "authentication": { "$ref": "#/components/schemas/WebhookAuthentication", "description": "Redacted authorization configuration for the webhook.", "nullable": true }, "signature_verification": { "$ref": "#/components/schemas/WebhookSignatureVerification", "description": "Redacted configuration for webhook signature verification.", "nullable": true }, "additional_headers": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookKeyValuePair" }, "description": "Additional headers as an array of key-value pairs.
Version: 26.4.0.cl or later", "nullable": true }, "creation_time_in_millis": { "type": "number", "format": "float", "description": "Creation time of the webhook configuration in milliseconds." }, "modification_time_in_millis": { "type": "number", "format": "float", "description": "Last modified time of the webhook configuration in milliseconds." }, "created_by": { "$ref": "#/components/schemas/WebhookUser", "description": "User who created the webhook.", "nullable": true }, "last_modified_by": { "$ref": "#/components/schemas/WebhookUser", "description": "User who last modified the webhook.", "nullable": true }, "storage_destination": { "$ref": "#/components/schemas/StorageDestination", "description": "Storage destination configuration for webhook payload delivery.", "nullable": true }, "status": { "type": "string", "enum": [ "ENABLED", "DISABLED" ], "description": "Status of the webhook (ENABLED or DISABLED).\nOnly present when explicitly set.
Version: 26.7.0.cl or later", "nullable": true } } }, "WebhookOrg": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the org." }, "name": { "type": "string", "description": "Name of the org." } } }, "WebhookAuthentication": { "type": "object", "properties": { "API_KEY": { "$ref": "#/components/schemas/WebhookAuthApiKey", "description": "Redacted API key authentication configuration.", "nullable": true }, "BASIC_AUTH": { "$ref": "#/components/schemas/WebhookAuthBasicAuth", "description": "Redacted Basic authentication configuration.", "nullable": true }, "BEARER_TOKEN": { "type": "string", "description": "Redacted Bearer token authentication configuration.", "nullable": true }, "OAUTH2": { "$ref": "#/components/schemas/WebhookAuthOAuth2", "description": "Redacted OAuth2 authentication configuration.", "nullable": true } } }, "WebhookAuthApiKey": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "description": "The header or query parameter name for the API key." }, "value": { "type": "string", "description": "The API key value." } } }, "WebhookAuthBasicAuth": { "type": "object", "required": [ "username", "password" ], "properties": { "username": { "type": "string", "description": "Username for basic authentication." }, "password": { "type": "string", "description": "Password for basic authentication." } } }, "WebhookAuthOAuth2": { "type": "object", "required": [ "authorization_url", "client_id", "client_secret" ], "properties": { "authorization_url": { "type": "string", "description": "OAuth2 authorization server URL." }, "client_id": { "type": "string", "description": "OAuth2 client identifier." }, "client_secret": { "type": "string", "description": "OAuth2 client secret key." } } }, "WebhookSignatureVerification": { "type": "object", "required": [ "type", "header", "algorithm", "secret" ], "properties": { "type": { "type": "string", "enum": [ "HMAC_SHA256" ], "description": "Signature verification method type." }, "header": { "type": "string", "description": "HTTP header where the signature is sent." }, "algorithm": { "type": "string", "enum": [ "SHA256" ], "description": "Hash algorithm used for signature verification." }, "secret": { "type": "string", "description": "Shared secret used for HMAC signature generation." } } }, "WebhookKeyValuePair": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "description": "Header name." }, "value": { "type": "string", "description": "Header value." } }, "description": "Key-value pair for additional webhook headers." }, "WebhookUser": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the user." }, "name": { "type": "string", "description": "Name of the user." } } }, "StorageDestination": { "type": "object", "required": [ "storage_type", "storage_config" ], "properties": { "storage_type": { "type": "string", "enum": [ "AWS_S3", "GCP_GCS" ], "description": "Type of storage destination (e.g., AWS_S3)." }, "storage_config": { "$ref": "#/components/schemas/StorageConfig", "description": "Storage-specific configuration settings." } }, "description": "Storage destination configuration for webhook payload delivery." }, "StorageConfig": { "type": "object", "properties": { "aws_s3_config": { "$ref": "#/components/schemas/AwsS3Config", "description": "AWS S3 storage configuration.", "nullable": true }, "gcp_gcs_config": { "$ref": "#/components/schemas/GcpGcsConfig", "description": "GCP GCS storage configuration.
Version: 26.7.0.cl or later", "nullable": true } }, "description": "Storage configuration containing provider-specific settings." }, "AwsS3Config": { "type": "object", "required": [ "bucket_name", "region", "role_arn" ], "properties": { "bucket_name": { "type": "string", "description": "Name of the S3 bucket where webhook payloads are stored." }, "region": { "type": "string", "description": "AWS region where the S3 bucket is located." }, "role_arn": { "type": "string", "description": "ARN of the IAM role used for S3 access." }, "external_id": { "type": "string", "description": "External ID for secure cross-account role assumption.", "nullable": true }, "path_prefix": { "type": "string", "description": "Path prefix for organizing objects within the bucket.", "nullable": true } }, "description": "AWS S3 storage configuration details." }, "GcpGcsConfig": { "type": "object", "required": [ "bucket_name", "service_account_email" ], "properties": { "bucket_name": { "type": "string", "description": "Name of the GCS bucket where webhook payloads are stored." }, "service_account_email": { "type": "string", "description": "Email of the GCP service account to impersonate for bucket access." }, "path_prefix": { "type": "string", "description": "Path prefix for organizing objects within the bucket.", "nullable": true } }, "description": "GCP GCS storage configuration details." }, "WebhookPagination": { "type": "object", "required": [ "record_offset", "record_size", "total_count", "has_more" ], "properties": { "record_offset": { "type": "integer", "format": "int32", "description": "The starting record number from where the records are included." }, "record_size": { "type": "integer", "format": "int32", "description": "The number of records included in the response." }, "total_count": { "type": "integer", "format": "int32", "description": "Total number of webhook configurations available." }, "has_more": { "type": "boolean", "description": "Indicates whether more records are available beyond the current response." } } }, "CollectionSearchResponse": { "type": "object", "required": [ "collections" ], "properties": { "collections": { "type": "array", "items": { "$ref": "#/components/schemas/Collection" }, "description": "List of collections matching the search criteria." }, "record_offset": { "type": "integer", "format": "int32", "description": "The starting record number from where the records are included.", "nullable": true }, "record_size": { "type": "integer", "format": "int32", "description": "The number of records returned.", "nullable": true }, "is_last_batch": { "type": "boolean", "description": "Indicates if this is the last batch of results.", "nullable": true }, "count": { "type": "integer", "format": "int32", "description": "Total count of records returned.", "nullable": true } }, "description": "Response object for search collections operation." }, "Collection": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the collection." }, "name": { "type": "string", "description": "Name of the collection." }, "obj_id": { "type": "string", "description": "Custom object ID (obj_id) of the collection, if one is set.
Version: 26.9.0.cl or later", "nullable": true }, "description": { "type": "string", "description": "Description of the collection.", "nullable": true }, "metadata": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionMetadataItem" }, "description": "Metadata objects in the collection.", "nullable": true }, "created_at": { "type": "string", "description": "Creation timestamp in milliseconds.", "nullable": true }, "updated_at": { "type": "string", "description": "Last updated timestamp in milliseconds.", "nullable": true }, "author_name": { "type": "string", "description": "Name of the author who created the collection.", "nullable": true }, "author_id": { "type": "string", "description": "Unique identifier of the author.", "nullable": true }, "org": { "$ref": "#/components/schemas/CollectionEntityIdentifier", "description": "Org associated with the collection.", "nullable": true } }, "description": "Response object for a collection." }, "CollectionMetadataItem": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the metadata object.", "nullable": true }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionEntityIdentifier" }, "description": "List of identifiers for this metadata type.", "nullable": true } }, "description": "Metadata item in a collection response." }, "CollectionEntityIdentifier": { "type": "object", "properties": { "identifier": { "type": "string", "description": "Unique identifier of the entity.", "nullable": true }, "name": { "type": "string", "description": "Name of the entity.", "nullable": true } }, "description": "Entity identifier with name." }, "ChannelHistoryEventInput": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "LIVEBOARD_SCHEDULE" ], "description": "Type of the event." }, "identifier": { "type": "string", "description": "Unique ID or name of the event.", "nullable": true } }, "description": "Event specification for channel history search." }, "SearchChannelHistoryResponse": { "type": "object", "required": [ "jobs" ], "properties": { "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelHistoryJob" }, "description": "List of job execution records." } }, "description": "Response wrapper for channel delivery history." }, "ChannelHistoryJob": { "type": "object", "required": [ "id", "status", "creation_time_in_millis" ], "properties": { "id": { "type": "string", "description": "Unique identifier for this job." }, "status": { "type": "string", "enum": [ "PENDING", "RETRY", "SUCCESS", "FAILED" ], "description": "Delivery status of this job." }, "creation_time_in_millis": { "type": "number", "format": "float", "description": "Timestamp when this job was created (epoch milliseconds)." }, "event": { "$ref": "#/components/schemas/ChannelHistoryEventInfo", "description": "Event metadata for the triggering event associated with this job.", "nullable": true }, "recipients": { "type": "array", "items": { "$ref": "#/components/schemas/JobRecipient" }, "description": "The users, groups or external recipients for this job.", "nullable": true }, "detail": { "type": "string", "description": "Additional delivery details such as HTTP response code or error message.", "nullable": true }, "try_count": { "type": "integer", "format": "int32", "description": "Number of attempts made. 1 indicates first attempt.", "nullable": true } }, "description": "A single job execution record for a channel." }, "ChannelHistoryEventInfo": { "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "enum": [ "LIVEBOARD_SCHEDULE" ], "description": "Type of the event." }, "id": { "type": "string", "description": "Unique ID of the event." }, "name": { "type": "string", "description": "Name of the event.", "nullable": true }, "run_id": { "type": "string", "description": "Unique run ID for this event execution.", "nullable": true } }, "description": "Event metadata for the triggering event associated with a job." }, "JobRecipient": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "USER", "EXTERNAL" ], "description": "Type of the recipient." }, "id": { "type": "string", "description": "Unique ID of the recipient.", "nullable": true }, "name": { "type": "string", "description": "Name of the recipient.", "nullable": true }, "email": { "type": "string", "description": "Email of the recipient.", "nullable": true } }, "description": "A recipient (user, group, or external) for a job execution." }, "StylePreference": { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "CLUSTER", "ORG" ], "description": "Scope at which these style preferences apply.", "nullable": true }, "org": { "$ref": "#/components/schemas/StyleOrgInfo", "description": "Org associated with these preferences. Present only when scope is ORG.", "nullable": true }, "navigation_panel": { "$ref": "#/components/schemas/StyleNavigationPanel", "description": "Navigation panel color configuration.", "nullable": true }, "chart_color_palette": { "$ref": "#/components/schemas/StyleChartColorPalette", "description": "Chart color palette configuration.", "nullable": true }, "embedded_footer_text": { "$ref": "#/components/schemas/StyleEmbeddedFooterText", "description": "Embedded footer text configuration.", "nullable": true }, "logo": { "$ref": "#/components/schemas/StyleLogoStatus", "description": "Logo status per slot.", "nullable": true }, "visualization_fonts": { "$ref": "#/components/schemas/StyleVisualizationFonts", "description": "Effective font assignments per visualization area.", "nullable": true } }, "description": "Style preferences for a single scope entry." }, "StyleOrgInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "description": "Unique integer ID of the org.", "nullable": true }, "name": { "type": "string", "description": "Name of the org.", "nullable": true } }, "description": "Org information returned in style API responses." }, "StyleNavigationPanel": { "type": "object", "properties": { "theme": { "type": "string", "enum": [ "DARK", "TWO_TONE", "CUSTOM" ], "description": "Navigation panel color mode.", "nullable": true }, "base_color": { "type": "string", "description": "Base color as a 6-digit hex string. Present only when theme is CUSTOM.", "nullable": true }, "is_overridden": { "type": "boolean", "description": "True if explicitly set at this scope, overriding any inherited value.", "nullable": true } }, "description": "Navigation panel color configuration for a specific scope." }, "StyleChartColorPalette": { "type": "object", "properties": { "colors": { "type": "array", "items": { "$ref": "#/components/schemas/StyleColorEntry" }, "description": "Ordered array of 8 color entries.", "nullable": true }, "disable_color_rotation": { "type": "boolean", "description": "When true, automatic color rotation across chart data series is disabled.", "nullable": true }, "is_overridden": { "type": "boolean", "description": "True if explicitly set at this scope, overriding any inherited value.", "nullable": true } }, "description": "Chart color palette configuration for a specific scope." }, "StyleColorEntry": { "type": "object", "properties": { "primary": { "type": "string", "description": "Primary color as a 6-digit hex string.", "nullable": true }, "secondary": { "type": "array", "items": { "type": "string" }, "description": "Array of 4 secondary shade hex strings.", "nullable": true } }, "description": "A single color entry in the chart color palette." }, "StyleEmbeddedFooterText": { "type": "object", "properties": { "value": { "type": "string", "description": "Footer text value. Empty string indicates no footer is set.", "nullable": true }, "is_overridden": { "type": "boolean", "description": "True if explicitly set at this scope, overriding any inherited value.", "nullable": true } }, "description": "Embedded footer text configuration for a specific scope." }, "StyleLogoStatus": { "type": "object", "properties": { "default_logo": { "$ref": "#/components/schemas/StyleLogoSlot", "description": "Status of the DEFAULT logo slot (square app icon and favicon; recommended\n140x140 px).", "nullable": true }, "wide_logo": { "$ref": "#/components/schemas/StyleLogoSlot", "description": "Status of the WIDE logo slot (horizontal top nav bar logo; recommended\n230x45 px).", "nullable": true } }, "description": "Logo status per slot." }, "StyleLogoSlot": { "type": "object", "properties": { "id": { "type": "string", "description": "UUID of the active logo.", "nullable": true }, "is_overridden": { "type": "boolean", "description": "True if a custom logo is uploaded at this scope. False if the system\ndefault or cluster logo is active.", "nullable": true } }, "description": "Status of a single logo slot." }, "StyleVisualizationFonts": { "type": "object", "properties": { "chart_visualization_fonts": { "type": "array", "items": { "$ref": "#/components/schemas/ChartVisualizationFontRecord" }, "description": "Font assignments for chart visualization areas.", "nullable": true }, "table_visualization_fonts": { "type": "array", "items": { "$ref": "#/components/schemas/TableVisualizationFontRecord" }, "description": "Font assignments for table visualization areas.", "nullable": true }, "advanced_chart_visualization_fonts": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedChartVisualizationFontRecord" }, "description": "Font assignments for advanced chart visualization areas.
Version: 26.7.0.cl or later", "nullable": true } }, "description": "Effective font assignments per visualization type." }, "ChartVisualizationFontRecord": { "type": "object", "properties": { "visualization_area": { "type": "string", "enum": [ "CHART_X_AXIS_LABELS", "CHART_X_AXIS_TITLE", "CHART_Y_AXIS_LABELS", "CHART_Y_AXIS_TITLE", "CHART_TOOLTIP", "CHART_SCATTER_DATA_LABELS", "CHART_DONUT_DATA_LABELS", "CHART_LINE_DATA_LABELS", "CHART_COLUMN_DATA_LABELS", "CHART_BAR_DATA_LABELS", "CHART_AREA_DATA_LABELS" ], "description": "Chart visualization area.", "nullable": true }, "font_id": { "type": "string", "description": "UUID of the font assigned to this area. Null when the system default font\nis active.", "nullable": true }, "font_name": { "type": "string", "description": "Display name of the font assigned to this area. Null when the system\ndefault font is active.", "nullable": true }, "is_overridden": { "type": "boolean", "description": "True if explicitly set at this scope, overriding any inherited value.", "nullable": true } }, "description": "Font assignment for a chart visualization area in the response." }, "TableVisualizationFontRecord": { "type": "object", "properties": { "visualization_area": { "type": "string", "enum": [ "TABLE_VALUE_CELLS" ], "description": "Table visualization area.", "nullable": true }, "font_id": { "type": "string", "description": "UUID of the font assigned to this area. Null when the system default font\nis active.", "nullable": true }, "font_name": { "type": "string", "description": "Display name of the font assigned to this area. Null when the system\ndefault font is active.", "nullable": true }, "is_overridden": { "type": "boolean", "description": "True if explicitly set at this scope, overriding any inherited value.", "nullable": true } }, "description": "Font assignment for a table visualization area in the response." }, "AdvancedChartVisualizationFontRecord": { "type": "object", "properties": { "visualization_area": { "type": "string", "enum": [ "ADVANCED_CHART_LABELS" ], "description": "Advanced chart visualization area.", "nullable": true }, "font_id": { "type": "string", "description": "UUID of the font assigned to this area. Null when the system default font\nis active.", "nullable": true }, "font_name": { "type": "string", "description": "Display name of the font assigned to this area. Null when the system\ndefault font is active.", "nullable": true }, "is_overridden": { "type": "boolean", "description": "True if explicitly set at this scope, overriding any inherited value.", "nullable": true } }, "description": "Font assignment for an advanced chart visualization area in the response." }, "StyleFontRecord": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "Unique UUID identifier of the font." }, "scope": { "type": "string", "enum": [ "CLUSTER", "ORG" ], "description": "Scope indicating whether this font belongs to the cluster or org library.", "nullable": true }, "org": { "$ref": "#/components/schemas/StyleOrgInfo", "description": "Org associated with this font. Present only when scope is ORG.", "nullable": true }, "name": { "type": "string", "description": "Display name of the font." }, "weight": { "type": "string", "enum": [ "NORMAL", "LIGHT", "BOLD" ], "description": "Weight of the font.", "nullable": true }, "style": { "type": "string", "enum": [ "NORMAL", "ITALIC", "OBLIQUE" ], "description": "Style of the font.", "nullable": true }, "color": { "type": "string", "description": "Color of the font as a 6-digit hex string.", "nullable": true }, "creation_time_in_millis": { "type": "number", "format": "float", "description": "Timestamp in milliseconds when the font was uploaded.", "nullable": true }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/StyleFontAssignment" }, "description": "Visualization areas currently assigned to this font. Empty if not assigned\nto any area. Populated only when include_font_assignments is true.", "nullable": true } }, "description": "A custom font record in the font library." }, "StyleFontAssignment": { "type": "object", "properties": { "org": { "$ref": "#/components/schemas/StyleOrgInfo", "description": "Org context for this assignment. Present only when scope is ORG.", "nullable": true }, "visualization_areas": { "type": "array", "items": { "type": "string", "enum": [ "CHART_X_AXIS_LABELS", "CHART_X_AXIS_TITLE", "CHART_Y_AXIS_LABELS", "CHART_Y_AXIS_TITLE", "CHART_TOOLTIP", "CHART_SCATTER_DATA_LABELS", "CHART_DONUT_DATA_LABELS", "CHART_LINE_DATA_LABELS", "CHART_COLUMN_DATA_LABELS", "CHART_BAR_DATA_LABELS", "CHART_AREA_DATA_LABELS", "TABLE_VALUE_CELLS", "ADVANCED_CHART_LABELS" ] }, "description": "Visualization areas using this font.", "nullable": true } }, "description": "Visualization areas assigned to a font, grouped by org context." }, "SemanticIntegrationSortOptions": { "type": "object", "properties": { "field_name": { "type": "string", "enum": [ "NAME", "AUTHOR", "CREATED_TIME", "MODIFIED_TIME" ], "description": "Name of the field to apply the sort on.", "nullable": true }, "order": { "type": "string", "enum": [ "ASC", "DESC" ], "description": "Sort order: `ASC` for ascending, `DESC` for descending.", "nullable": true } }, "description": "Sort options for semantic integration search." }, "SemanticIntegrationSearchResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the semantic integration.", "nullable": true }, "name": { "type": "string", "description": "Name of the semantic integration.", "nullable": true }, "description": { "type": "string", "description": "Optional description of the semantic integration.", "nullable": true }, "model_id": { "type": "string", "description": "GUID of the associated ThoughtSpot model generated for this integration.", "nullable": true }, "model_name": { "type": "string", "description": "Name of the associated ThoughtSpot model.", "nullable": true }, "import_type": { "type": "string", "enum": [ "CDW", "FILE" ], "description": "How the semantic definition was sourced.", "nullable": true }, "type": { "type": "string", "enum": [ "RDBMS_SNOWFLAKE", "RDBMS_DATABRICKS" ], "description": "CDW connector type.", "nullable": true }, "connection_id": { "type": "string", "description": "GUID of the CDW connection backing the integration.", "nullable": true }, "connection_name": { "type": "string", "description": "Display name of the CDW connection backing the integration.", "nullable": true }, "author_id": { "type": "string", "description": "GUID of the user who created the integration.", "nullable": true }, "author_name": { "type": "string", "description": "Username of the user who created the integration.", "nullable": true }, "creation_time_in_millis": { "type": "number", "format": "float", "description": "Creation time in Unix epoch milliseconds.", "nullable": true }, "modification_time_in_millis": { "type": "number", "format": "float", "description": "Last modification time in Unix epoch milliseconds.", "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/SemanticIntegrationTagReference" }, "description": "Tags associated with the integration.", "nullable": true } }, "description": "Single semantic integration entry returned by search." }, "SemanticIntegrationTagReference": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the tag.", "nullable": true }, "name": { "type": "string", "description": "Name of the tag.", "nullable": true } }, "description": "Tag reference associated with a semantic integration." }, "FeatureGroup": { "type": "object", "required": [ "features" ], "properties": { "feature_group": { "type": "string", "description": "Display name of the feature group.", "nullable": true }, "docs_url": { "type": "string", "description": "Documentation URL for the feature group, when available.", "nullable": true }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureDetail" }, "description": "Feature details within this group. Each entry contains the fields relevant to\nthe requested scope; org-admin-only and cluster-admin-only fields are null in\nthe other view." } }, "description": "A named group of related features. Returned by searchFeatures; the contents of\nfeatures depend on the requested scope (cluster-admin vs. org-admin view)." }, "FeatureDetail": { "type": "object", "required": [ "feature_id" ], "properties": { "feature_id": { "type": "string", "description": "Underlying unique feature ID. The dotted-path format (for example,\n`orion.embraceConfig.doIndexing`) is internal and subject to change without\nnotice; use `feature_name` as the stable display identifier where possible." }, "feature_name": { "type": "string", "description": "User-friendly feature name. Present when the feature declares one.", "nullable": true }, "assigned_orgs": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureOrgInfo" }, "description": "Orgs currently assigned to this feature. Populated in the cluster-admin view.", "nullable": true }, "is_org_aware": { "type": "boolean", "description": "Whether the feature is Org-aware. Org-aware features are managed via per-Org\nassignment; non-org-aware features are cluster-level toggles. Populated in the\ncluster-admin view.", "nullable": true }, "feature_value": { "type": "string", "description": "Current cluster-level value of the feature. Populated in the cluster-admin\nview for non-org-aware features; null for Org-aware features. Values are\nalways returned as strings; for boolean toggles this is `\"true\"` or\n`\"false\"`.", "nullable": true }, "element_type": { "type": "string", "description": "UI element type hint for the feature. Populated in the org-admin view.", "nullable": true }, "element_config": { "type": "object", "description": "UI element configuration for the feature. Populated in the org-admin view.\nAn opaque blob whose structure varies by `element_type`; a `label` string is\nthe common envelope field.", "nullable": true }, "element_value": { "type": "string", "description": "Current value of the feature for the requested Org. Populated in the\norg-admin view.", "nullable": true }, "docs_url": { "type": "string", "description": "Per-feature documentation URL, when available.", "nullable": true } }, "description": "Detail for a single feature. Fields are populated according to the scope of the\nsearch: cluster-admin (CLUSTER) responses populate assigned_orgs, is_org_aware,\nand (for non-org-aware features) feature_value; org-admin (ORG) responses\npopulate element_type, element_config, and element_value." }, "FeatureOrgInfo": { "type": "object", "required": [ "org_id", "org_name" ], "properties": { "org_id": { "type": "integer", "format": "int32", "description": "Numeric ID of the Org." }, "org_name": { "type": "string", "description": "Display name of the Org." } }, "description": "Lightweight Org identifier and display name, as returned in feature\nassignment responses.\nThe field names org_id / org_name intentionally deviate from the bare id /\nname used by the shared Org type: they are the literal wire keys emitted by\nthe Callosum backend, so they are load-bearing for Prism's response field\nmapping and cannot be renamed without a backend change." }, "GenericInfo": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } } }, "UserGroup": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } } }, "TokenScopeInput": { "type": "object", "required": [ "org_scope" ], "properties": { "org_scope": { "type": "string", "enum": [ "SPECIFIC_ORGS", "ALL_MEMBER_ORGS" ], "description": "The set of Orgs this token is authorized to operate in. SPECIFIC_ORGS authorizes the token for the Orgs listed in org_identifiers; ALL_MEMBER_ORGS authorizes it for all Orgs the user is a member of.
Beta Version: 26.10.0.cl or later" }, "org_identifiers": { "type": "array", "items": { "type": "string" }, "description": "ID or name of the Orgs the token is authorized for. Required when org_scope is SPECIFIC_ORGS; ignored when org_scope is ALL_MEMBER_ORGS.
Beta Version: 26.10.0.cl or later", "nullable": true } }, "description": "The set of Orgs a token is authorized to operate in, recorded at issuance. Only applicable to a Tenant Administrator." }, "JWT_User_Options": { "type": "object", "properties": { "parameters": { "items": { "anyOf": [ { "$ref": "#/components/schemas/Runtime_Filter" }, { "$ref": "#/components/schemas/Runtime_Sort" }, { "$ref": "#/components/schemas/Runtime_Param_Override" } ] } }, "metadata": { "type": "array", "items": { "$ref": "#/components/schemas/JWT_Metadata_Object" }, "nullable": true } }, "description": "JWT user options to create a JWT token given the payload.\n\n\n*Deprecated in 9.12.0.cl. Use user_parameters instead.*" }, "JWT_Parameter": { "type": "object", "properties": { "runtime_filter": { "type": "object", "description": "Runtime filter parameter type in JWT.", "nullable": true }, "runtime_sort": { "type": "object", "description": "Runtime sort parameter type in JWT.", "nullable": true }, "runtime_param_override": { "type": "object", "description": "Runtime param override type in JWT.", "nullable": true } }, "description": "List of runtime parameters need to set during the session." }, "JWT_Metadata_Object": { "type": "object", "properties": { "identifier": { "type": "string", "nullable": true }, "type": { "type": "string", "enum": [ "LOGICAL_TABLE" ], "nullable": true } }, "description": "Metadata objects." }, "User_Parameter_Options": { "type": "object", "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/User_Object" }, "nullable": true }, "runtime_filters": { "type": "array", "items": { "$ref": "#/components/schemas/Runtime_Filters" }, "description": "Objects to apply the User_Runtime_Filters.\n\nExamples to set the `runtime_filters` :\n```json\n{ \"column_name\": \"Color\", \"operator\": \"EQ\", \"values\": [\"red\"], \"persist\": false }\n```", "nullable": true }, "runtime_sorts": { "type": "array", "items": { "$ref": "#/components/schemas/Runtime_Sorts" }, "description": "Objects to apply the User_Runtime_Sorts.\n\nExamples to set the `runtime_sorts` :\n```json\n{ \"column_name\": \"Color\", \"order\": \"ASC\", \"persist\": false }\n```", "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/Runtime_Parameters" }, "description": "Objects to apply the Runtime_Parameters.\n\nExamples to set the `parameters` :\n```json\n{ \"name\": \"Color\", \"values\": [\"Blue\"], \"persist\": false }\n```", "nullable": true } }, "description": "Define attributes such as Runtime filters and Runtime parameters to send security entitlements to a user session. For more information, see [Documentation](https://developers.thoughtspot.com/docs/abac-user-parameters).\n" }, "User_Object": { "type": "object", "required": [ "identifier" ], "properties": { "type": { "type": "string", "enum": [ "LOGICAL_TABLE" ], "description": " Type of object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.\n \n\n Specify the object type as `LOGICAL_TABLE`.", "nullable": true }, "identifier": { "type": "string", "description": "Unique name/id of the object." } }, "description": "Objects to apply the User_Object." }, "Runtime_Filters": { "type": "object", "required": [ "column_name", "values", "operator" ], "properties": { "column_name": { "type": "string", "description": "The column name to apply filter." }, "values": { "type": "array", "items": { "type": "string" }, "description": "Value of the filters." }, "operator": { "type": "string", "enum": [ "EQ", "NE", "LT", "LE", "GT", "GE", "IN", "BW", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BW_INC", "BW_INC_MIN", "BW_INC_MAX", "LIKE", "NOT_IN" ], "description": "Operator value. Example: EQ" }, "persist": { "type": "boolean", "default": false, "description": "Flag to persist the runtime filters.
Version: 9.12.0.cl or later", "nullable": true }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/User_Object" }, "description": "Object to apply the runtime filter.", "nullable": true } }, "description": "Objects to apply the Runtime_Filters." }, "Runtime_Sorts": { "type": "object", "properties": { "column_name": { "type": "string", "description": "The column name to apply filter.", "nullable": true }, "order": { "type": "string", "enum": [ "ASC", "DESC" ], "description": "Order for the sort.", "nullable": true }, "persist": { "type": "boolean", "default": false, "description": "Flag to persist the runtime sorts.
Version: 9.12.0.cl or later", "nullable": true }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/User_Object" }, "description": "Object to apply the runtime sort.", "nullable": true } }, "description": "Objects to apply the Runtime_Sorts." }, "Runtime_Parameters": { "type": "object", "required": [ "name", "values" ], "properties": { "name": { "type": "string", "description": "The name of the parameter." }, "values": { "type": "array", "items": { "type": "string" }, "description": "The array of values." }, "persist": { "type": "boolean", "default": false, "description": "Flag to persist the parameters.
Version: 9.12.0.cl or later", "nullable": true }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/User_Object" }, "description": "Object to apply the runtime parameter.", "nullable": true } }, "description": "Objects to apply the Runtime_Parameters." }, "Token": { "type": "object", "required": [ "token", "creation_time_in_millis", "expiration_time_in_millis", "scope", "valid_for_user_id", "valid_for_username" ], "properties": { "token": { "type": "string", "description": "Bearer auth token." }, "creation_time_in_millis": { "type": "number", "format": "float", "description": "Token creation time in milliseconds." }, "expiration_time_in_millis": { "type": "number", "format": "float", "description": "Token expiration time in milliseconds." }, "scope": { "$ref": "#/components/schemas/Scope", "description": "Token access scope details" }, "valid_for_user_id": { "type": "string", "description": "Username to whom the token is issued." }, "valid_for_username": { "type": "string", "description": "Unique identifier of the user to whom the token is issued." } } }, "Scope": { "type": "object", "required": [ "access_type" ], "properties": { "access_type": { "type": "string", "description": "Object access scope type." }, "org_id": { "type": "integer", "format": "int32", "description": "Unique identifier of the Org.", "nullable": true }, "metadata_id": { "type": "string", "description": "Unique identifier of the metadata.", "nullable": true }, "org_scope": { "type": "string", "enum": [ "SPECIFIC_ORGS", "ALL_MEMBER_ORGS" ], "description": "Org scope the token is authorized for. Absent for a legacy single-org token.
Beta Version: 26.10.0.cl or later", "nullable": true }, "org_ids": { "type": "array", "items": { "$ref": "#/components/schemas/OrgInfo" }, "description": "Orgs the token is authorized for when org_scope is SPECIFIC_ORGS.
Beta Version: 26.10.0.cl or later", "nullable": true } } }, "OrgInfo": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32", "description": "Id." }, "name": { "type": "string", "description": "Name.", "nullable": true } } }, "JWT_User_Options_Full": { "type": "object", "properties": { "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/JWT_Parameter" }, "nullable": true } }, "description": "JWT user options to create a JWT token given the payload.\n\n\n*Deprecated in 9.12.0.cl. Use user_parameters instead.*" }, "TokenValidationResponse": { "type": "object", "required": [ "creation_time_in_millis", "expiration_time_in_millis", "scope", "valid_for_user_id", "token_type" ], "properties": { "creation_time_in_millis": { "type": "number", "format": "float", "description": "Token creation time in milliseconds." }, "expiration_time_in_millis": { "type": "number", "format": "float", "description": "Token expiration time in milliseconds." }, "scope": { "$ref": "#/components/schemas/Scope", "description": "Token access scope details" }, "valid_for_user_id": { "type": "string", "description": "Username to whom the token is issued." }, "token_type": { "type": "string", "description": "Type of token." } } }, "FilterRules": { "type": "object", "required": [ "column_name", "operator", "values" ], "properties": { "column_name": { "type": "string", "description": "The name of the column to apply the filter on." }, "operator": { "type": "string", "enum": [ "EQ", "NE", "LT", "LE", "GT", "GE", "IN", "BW", "CONTAINS", "BEGINS_WITH", "ENDS_WITH", "BW_INC", "BW_INC_MIN", "BW_INC_MAX", "LIKE", "NOT_IN" ], "description": "The operator to use for filtering. Example: EQ (equals), GT(greater than), etc." }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] }, "description": "The values to filter on. To get all records, use TS_WILDCARD_ALL as values." } }, "description": "Filter Rules to be applied on Objects." }, "ParameterValues": { "type": "object", "required": [ "name", "values" ], "properties": { "name": { "type": "string", "description": "The name of the column to apply the filter on." }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] }, "description": "The values to filter on. Only single value is supported currently." } }, "description": "Filter Rules to be applied on Objects." }, "VariableValues": { "type": "object", "required": [ "name", "values" ], "properties": { "name": { "type": "string", "description": "The name of the existing formula variable." }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] }, "description": "The values to filter on." } }, "description": "Variable values." }, "TokenAccessScopeObject": { "type": "object", "required": [ "identifier" ], "properties": { "type": { "type": "string", "enum": [ "LOGICAL_TABLE" ], "description": " Type of object.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.\n \n\n Specify the object type as `LOGICAL_TABLE`.", "nullable": true }, "identifier": { "type": "string", "description": "Unique name/id of the object." } }, "description": "Objects on which the filter rules and parameters values should be applied to" }, "Group_Object": { "type": "object", "properties": { "identifier": { "type": "string", "nullable": true } }, "description": "Groups objects." }, "AccessToken": { "type": "object", "required": [ "token", "org", "user", "creation_time_in_millis", "expiration_time_in_millis" ], "properties": { "id": { "type": "string", "description": "GUID of the auth token.", "nullable": true }, "token": { "type": "string", "description": "Bearer auth token." }, "org": { "$ref": "#/components/schemas/OrgInfo", "description": "Org information for which the token is generated." }, "user": { "$ref": "#/components/schemas/UserInfo", "description": "User information for which the token is generated." }, "creation_time_in_millis": { "type": "number", "format": "float", "description": "Token creation time in milliseconds." }, "expiration_time_in_millis": { "type": "number", "format": "float", "description": "Token expiration time in milliseconds." }, "scope": { "$ref": "#/components/schemas/AccessTokenScope", "description": "The set of Orgs this token is authorized to operate in, recorded at issuance. Absent for a legacy single-org token.
Beta Version: 26.10.0.cl or later", "nullable": true } } }, "UserInfo": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Id." }, "name": { "type": "string", "description": "Name.", "nullable": true } } }, "AccessTokenScope": { "type": "object", "required": [ "org_scope" ], "properties": { "org_scope": { "type": "string", "enum": [ "SPECIFIC_ORGS", "ALL_MEMBER_ORGS" ], "description": "Org scope the token is authorized for: SPECIFIC_ORGS or ALL_MEMBER_ORGS." }, "org_ids": { "type": "array", "items": { "$ref": "#/components/schemas/OrgInfo" }, "description": "Orgs the token is authorized for when org_scope is SPECIFIC_ORGS.", "nullable": true } }, "description": "The set of Orgs a token is authorized to operate in, recorded at issuance. Used for token\ntypes (e.g. AccessToken) that have no other {@code scope} field of their own." }, "AuthClusterPreferencesInput": { "type": "object", "properties": { "auth_status": { "type": "string", "enum": [ "ENABLED", "DISABLED" ], "description": "Enable or disable authentication at the cluster level. When enabled, a new token is generated if one does not exist. When disabled, the existing token is revoked.", "nullable": true } }, "description": "Input for cluster-level auth configuration." }, "AuthOrgPreferenceInput": { "type": "object", "required": [ "org_identifier" ], "properties": { "org_identifier": { "type": "string", "description": "Unique ID or name of the org to configure." }, "auth_status": { "type": "string", "enum": [ "ENABLED", "DISABLED" ], "description": "Enable or disable authentication for this org. When enabled, a new token is generated if one does not exist. When disabled, the existing token is revoked.", "nullable": true } }, "description": "Input for org-level auth configuration." }, "ResponseActivationURL": { "type": "object", "properties": { "activation_link": { "type": "string", "description": "Activation link to activate the user.", "nullable": true } }, "description": "The object representation with activation link." }, "ImportUser": { "type": "object", "required": [ "user_identifier", "display_name" ], "properties": { "user_identifier": { "type": "string", "description": "Unique ID or name of the user." }, "display_name": { "type": "string", "description": "Display name of the user." }, "password": { "type": "string", "description": "Password of the user.", "nullable": true }, "account_type": { "type": "string", "enum": [ "LOCAL_USER", "LDAP_USER", "SAML_USER", "OIDC_USER", "REMOTE_USER" ], "description": "Type of the user account.", "nullable": true }, "account_status": { "type": "string", "enum": [ "ACTIVE", "INACTIVE", "EXPIRED", "LOCKED", "PENDING", "SUSPENDED" ], "description": "Status of the user account.", "nullable": true }, "email": { "type": "string", "description": "Email address of the user.", "nullable": true }, "org_identifiers": { "type": "array", "items": { "type": "string" }, "description": "ID or name of the Orgs to which the user belongs.", "nullable": true }, "group_identifiers": { "type": "array", "items": { "type": "string" }, "description": "ID or name of the groups to which the user belongs.", "nullable": true }, "visibility": { "type": "string", "enum": [ "SHARABLE", "NON_SHARABLE" ], "description": "Visibility of the users. The SHARABLE property makes a user visible to other users and group, who can share objects with the user.", "nullable": true }, "notify_on_share": { "type": "boolean", "default": true, "description": "Notify user when other users or groups share metadata objects", "nullable": true }, "show_onboarding_experience": { "type": "boolean", "description": "Show or hide the new user onboarding walkthroughs", "nullable": true }, "onboarding_experience_completed": { "type": "boolean", "description": "Revisit the new user onboarding walkthroughs", "nullable": true }, "home_liveboard_identifier": { "type": "string", "description": "Unique ID or name of the default Liveboard assigned to the user.", "nullable": true }, "favorite_metadata": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteMetadataInput" }, "description": "Metadata objects to add to the user's favorites list.", "nullable": true }, "preferred_locale": { "type": "string", "description": "Locale for the user. When setting this value, do not set use_browser_language to true, otherwise the browser's language setting will take precedence and the preferred_locale value will be ignored.", "nullable": true, "enum": [ "en-CA", "en-GB", "en-US", "de-DE", "ja-JP", "zh-CN", "pt-BR", "fr-FR", "fr-CA", "es-US", "da-DK", "es-ES", "fi-FI", "sv-SE", "nb-NO", "pt-PT", "nl-NL", "it-IT", "ru-RU", "en-IN", "de-CH", "en-NZ", "es-MX", "en-AU", "zh-Hant", "ko-KR", "en-DE" ] }, "use_browser_language": { "type": "boolean", "description": "Flag to indicate whether to use the browser locale for the user in the UI.\nWhen set to true, the preferred_locale value is unset and the browser's\nlanguage setting takes precedence.
Version: 26.3.0.cl or later", "nullable": true } } }, "ImportUsersResponse": { "type": "object", "properties": { "users_added": { "type": "array", "items": { "$ref": "#/components/schemas/ImportUserType" }, "nullable": true }, "users_updated": { "type": "array", "items": { "$ref": "#/components/schemas/ImportUserType" }, "nullable": true }, "users_deleted": { "type": "array", "items": { "$ref": "#/components/schemas/ImportUserType" }, "nullable": true } } }, "ImportUserType": { "type": "object", "required": [ "name" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the user.", "nullable": true }, "name": { "type": "string", "description": "Name of the user." } } }, "EventChannelConfigInput": { "type": "object", "required": [ "event_type", "channels" ], "properties": { "event_type": { "type": "string", "enum": [ "LIVEBOARD_SCHEDULE" ], "description": "Type of event for which communication channels are configured" }, "channels": { "type": "array", "items": { "type": "string", "enum": [ "EMAIL", "WEBHOOK" ] }, "description": "Communication channels enabled for this event type. Empty array disables all channels for this event." } } }, "OrgChannelConfigInput": { "type": "object", "required": [ "org_identifier" ], "properties": { "org_identifier": { "type": "string", "description": "Unique identifier or name of the org" }, "operation": { "type": "string", "enum": [ "REPLACE", "RESET" ], "default": "REPLACE", "description": "Operation to perform. REPLACE: Update preferences (default). RESET: Remove org-specific configurations, causing fallback to cluster-level preferences.", "nullable": true }, "preferences": { "type": "array", "items": { "$ref": "#/components/schemas/EventChannelConfigInput" }, "description": "Event-specific configurations. Required for REPLACE operation.", "nullable": true }, "reset_events": { "type": "array", "items": { "type": "string", "enum": [ "LIVEBOARD_SCHEDULE" ] }, "description": "Event types to reset. Required for RESET operation. Org-specific configurations for these events will be removed, causing fallback to cluster-level preferences.", "nullable": true } } }, "SecuritySettingsClusterPreferencesInput": { "type": "object", "properties": { "enable_partitioned_cookies": { "type": "boolean", "description": "Support embedded access when third-party cookies are blocked.", "nullable": true }, "cors_whitelisted_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed origins for CORS.", "nullable": true }, "csp_settings": { "$ref": "#/components/schemas/CspSettingsInput", "description": "CSP (Content Security Policy) settings.", "nullable": true }, "saml_redirect_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed redirect hosts for SAML login.", "nullable": true }, "non_embed_access": { "$ref": "#/components/schemas/ClusterNonEmbedAccessInput", "description": "Non-embed access configuration at cluster level.", "nullable": true } }, "description": "Input for cluster-level security preferences configuration." }, "CspSettingsInput": { "type": "object", "properties": { "connect_src_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed URLs for connect-src directive.", "nullable": true }, "font_src_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed URLs for font-src directive.", "nullable": true }, "visual_embed_hosts": { "type": "array", "items": { "type": "string" }, "description": "Allowed hosts for visual embed (frame-ancestors directive).", "nullable": true }, "iframe_src_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed URLs for frame-src directive.", "nullable": true }, "img_src_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed URLs for img-src directive.", "nullable": true }, "script_src_urls": { "$ref": "#/components/schemas/ScriptSrcUrlsInput", "description": "Script-src settings including URLs and enabled flag.", "nullable": true }, "style_src_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed URLs for style-src directive.", "nullable": true } }, "description": "Input for CSP (Content Security Policy) settings." }, "ScriptSrcUrlsInput": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether script-src customization is enabled.", "nullable": true }, "urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed URLs for script-src directive. Can only be set if enabled is true.", "nullable": true } }, "description": "Input for script-src CSP settings." }, "ClusterNonEmbedAccessInput": { "type": "object", "properties": { "block_full_app_access": { "type": "boolean", "description": "Block full application access for non-embedded usage.", "nullable": true }, "groups_identifiers_with_access": { "type": "array", "items": { "type": "string" }, "description": "Group identifiers that are allowed non-embed full app access.\nCan only be set when orgs feature is disabled and block_full_app_access is true.", "nullable": true } }, "description": "Input for cluster-level non-embed access configuration." }, "SecuritySettingsOrgPreferencesInput": { "type": "object", "required": [ "org_identifier" ], "properties": { "org_identifier": { "type": "string", "description": "Unique identifier or name of the org" }, "cors_whitelisted_urls": { "type": "array", "items": { "type": "string" }, "description": "Allowed origins for CORS for this org.", "nullable": true }, "non_embed_access": { "$ref": "#/components/schemas/OrgNonEmbedAccessInput", "description": "Non-embed access configuration for this org.", "nullable": true } }, "description": "Input for org-level security preferences configuration.\nNote: cross-org operations are not supported currently." }, "OrgNonEmbedAccessInput": { "type": "object", "properties": { "block_full_app_access": { "type": "boolean", "description": "Block full application access for non-embedded usage.", "nullable": true }, "groups_identifiers_with_access": { "type": "array", "items": { "type": "string" }, "description": "Group identifiers that are allowed non-embed full app access. Can only be set if block_full_app_access is true.", "nullable": true } }, "description": "Input for org-level non-embed access configuration." }, "CommunicationChannelValidateResponse": { "type": "object", "required": [ "channel_type", "channel_id", "event_type", "job_id", "result_code" ], "properties": { "channel_type": { "type": "string", "enum": [ "WEBHOOK" ], "description": "Type of communication channel that was validated." }, "channel_id": { "type": "string", "description": "ID of the communication channel (e.g., webhook_id)." }, "channel_name": { "type": "string", "description": "Name of the communication channel (e.g., webhook name).", "nullable": true }, "event_type": { "type": "string", "enum": [ "LIVEBOARD_SCHEDULE" ], "description": "Event type that was validated." }, "job_id": { "type": "string", "description": "Unique Job Id of the validation." }, "result_code": { "type": "string", "enum": [ "SUCCESS", "FAILED", "PARTIAL_SUCCESS" ], "description": "Overall result of the validation." }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelValidationDetail" }, "description": "Detailed results of various validation sub-steps.", "nullable": true } }, "description": "Response containing validation results for communication channel configuration." }, "ChannelValidationDetail": { "type": "object", "required": [ "validation_step", "status" ], "properties": { "validation_step": { "type": "string", "enum": [ "HTTP_CONNECTION_CHECK", "STORAGE_FILE_UPLOAD_CHECK" ], "description": "The validation step that was performed." }, "status": { "type": "string", "enum": [ "SUCCESS", "FAILED" ], "description": "Status of this validation step." }, "http_status": { "type": "integer", "format": "int32", "description": "HTTP status code returned by the channel (if applicable).", "nullable": true }, "error_message": { "type": "string", "description": "Error message from the channel or validation process.", "nullable": true }, "aws_s3_info": { "$ref": "#/components/schemas/ChannelValidationAwsS3Info", "description": "AWS S3 storage information from the validation step.", "nullable": true }, "gcp_gcs_info": { "$ref": "#/components/schemas/ChannelValidationGcpGcsInfo", "description": "GCP GCS storage information from the validation step.
Version: 26.7.0.cl or later", "nullable": true } }, "description": "Validation detail result for a sub-step." }, "ChannelValidationAwsS3Info": { "type": "object", "properties": { "bucket_name": { "type": "string", "description": "Name of the S3 bucket.", "nullable": true }, "file_name": { "type": "string", "description": "Name of the uploaded file.", "nullable": true }, "object_key": { "type": "string", "description": "Key of the object in S3 storage.", "nullable": true } }, "description": "AWS S3 storage information returned from a validation step." }, "ChannelValidationGcpGcsInfo": { "type": "object", "properties": { "bucket_name": { "type": "string", "description": "Name of the GCS bucket.", "nullable": true }, "file_name": { "type": "string", "description": "Name of the uploaded file.", "nullable": true }, "object_key": { "type": "string", "description": "Key (path) of the object within the GCS bucket.", "nullable": true } }, "description": "GCP GCS storage information returned from a validation step." }, "TagMetadataTypeInput": { "type": "object", "required": [ "identifier" ], "properties": { "type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "LOGICAL_COLUMN", "CONNECTION", "COLLECTION" ], "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.\n 1. LIVEBOARD\n 2. ANSWERS\n 3. LOGICAL_TABLE for any data object such as table, worksheet or view.\n 4. LOGICAL_COLUMN for a column of any data object such as tables, worksheets or views.", "nullable": true }, "identifier": { "type": "string", "description": "Unique ID or name of the metadata." } } }, "GroupsImportListInput": { "type": "object", "required": [ "display_name", "group_identifier" ], "properties": { "display_name": { "type": "string", "description": "Unique display name of the group." }, "group_identifier": { "type": "string", "description": "Unique ID or name of the group." }, "default_liveboard_identifiers": { "type": "array", "items": { "type": "string" }, "description": "Unique ID of Liveboards that will be assigned as default Liveboards to the users in the group.", "nullable": true }, "description": { "type": "string", "description": "Description of the group.", "nullable": true }, "privileges": { "type": "array", "items": { "type": "string", "enum": [ "ADMINISTRATION", "AUTHORING", "USERDATAUPLOADING", "DATADOWNLOADING", "USERMANAGEMENT", "DATAMANAGEMENT", "SHAREWITHALL", "JOBSCHEDULING", "A3ANALYSIS", "EXPERIMENTALFEATUREPRIVILEGE", "BYPASSRLS", "RANALYSIS", "DEVELOPER", "USER_ADMINISTRATION", "GROUP_ADMINISTRATION", "SYNCMANAGEMENT", "CAN_CREATE_CATALOG", "DISABLE_PINBOARD_CREATION", "LIVEBOARD_VERIFIER", "PREVIEW_THOUGHTSPOT_SAGE", "CAN_MANAGE_VERSION_CONTROL", "THIRDPARTY_ANALYSIS", "ALLOW_NON_EMBED_FULL_APP_ACCESS", "CAN_ACCESS_ANALYST_STUDIO", "CAN_MANAGE_ANALYST_STUDIO", "CAN_MODIFY_FOLDERS", "CAN_MANAGE_VARIABLES", "CAN_VIEW_FOLDERS", "CAN_MANAGE_AGENTSPOT", "CAN_ACCESS_AGENTSPOT", "PREVIEW_DOCUMENT_SEARCH", "CAN_SETUP_VERSION_CONTROL", "CAN_DOWNLOAD_VISUALS", "CAN_DOWNLOAD_DETAILED_DATA", "CAN_USE_SPOTTER", "CAN_MANAGE_SPOTTER", "CAN_CREATE_LIVEBOARD", "CAN_CREATE_ANSWERS", "CAN_ANALYZE_DATA", "CAN_ADMINISTER_SCHEDULES", "CAN_CREATE_KPI_ALERTS" ] }, "description": "Privileges that will be assigned to the group. Note: AUTHORING is a no-op — always inherited via ALL_GROUP, assigning it has no effect.", "nullable": true }, "sub_group_identifiers": { "type": "array", "items": { "type": "string" }, "description": "Unique ID or name of the sub-groups to add to the group.", "nullable": true }, "type": { "type": "string", "enum": [ "LOCAL_GROUP", "LDAP_GROUP", "TEAM_GROUP", "TENANT_GROUP" ], "description": "Type of the group.", "nullable": true }, "user_identifiers": { "type": "array", "items": { "type": "string" }, "description": "Unique ID or name of the users to assign to the group.", "nullable": true }, "visibility": { "type": "string", "enum": [ "SHARABLE", "NON_SHARABLE" ], "description": "Visibility of the group. The SHARABLE makes a group visible to other users and groups, and thus allows them to share objects.", "nullable": true } } }, "ImportUserGroupsResponse": { "type": "object", "required": [ "groups_added", "groups_deleted", "groups_updated" ], "properties": { "groups_added": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, "description": "The groups which are added into the system." }, "groups_deleted": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, "description": "The groups which are deleted from the system." }, "groups_updated": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, "description": "The groups which are updated in the system." } } }, "Export_Options": { "type": "object", "properties": { "include_obj_id_ref": { "type": "boolean", "default": false, "description": "Boolean Flag to export Object ID of referenced object. This flag will work only after the Object ID feature has been enabled. Please contact support to enable the feature.", "nullable": true }, "include_guid": { "type": "boolean", "default": true, "description": "Boolean flag to export guid of the object. This flag will work only after the Object ID feature has been enabled. Please contact support to enable the feature.", "nullable": true }, "include_obj_id": { "type": "boolean", "default": false, "description": "Boolean flag to export Object ID of the object. This flag will work only after the Object ID feature has been enabled. Please contact support to enable the feature.", "nullable": true }, "export_with_associated_feedbacks": { "type": "boolean", "default": false, "description": "Boolean flag indicating whether to export associated feedbacks of the object. This will only be respected when the object can have feedbacks.
Version: 10.7.0.cl or later", "nullable": true }, "export_column_security_rules": { "type": "boolean", "default": false, "description": "Boolean flag indicating whether to export column security rules of the object. This will only be respected when the object can have column security rules and export_associated is true.
Beta Version: 10.12.0.cl or later", "nullable": true }, "export_with_column_aliases": { "type": "boolean", "default": false, "description": "Boolean flag indicating whether to export column aliases of the model. This will only be respected when the object can have column aliases.
Beta Version: 10.13.0.cl or later", "nullable": true } }, "description": "Flags to specify additional options for export. This will only be active when UserDefinedId in TML is enabled." }, "ResponseCopyObject": { "type": "object", "properties": { "metadata_id": { "type": "string", "description": "The unique identifier of the object.", "nullable": true } } }, "ResponseWorksheetToModelConversion": { "type": "object", "required": [ "name", "success_count", "failure_count", "incomplete_count", "post_upgrade_failed_count", "total_time_in_millis", "successful_entities", "failed_entities", "incomplete_entities", "post_upgrade_failed_entities" ], "properties": { "name": { "type": "string" }, "success_count": { "type": "integer", "format": "int32", "description": "The number of worksheets successfully converted to models." }, "failure_count": { "type": "integer", "format": "int32", "description": "The number of worksheets that failed to convert." }, "incomplete_count": { "type": "integer", "format": "int32", "description": "The number of worksheets that were incomplete during the conversion process." }, "post_upgrade_failed_count": { "type": "integer", "format": "int32", "description": "The number of worksheets that failed after an upgrade during the conversion process." }, "total_time_in_millis": { "type": "integer", "format": "int32", "description": "The total time taken to complete the conversion process in milliseconds." }, "successful_entities": { "$ref": "#/components/schemas/ResponseSuccessfulEntities", "description": "List of worksheets successfully converted to models." }, "failed_entities": { "$ref": "#/components/schemas/ResponseFailedEntities", "description": "List of worksheets that failed to convert." }, "incomplete_entities": { "$ref": "#/components/schemas/ResponseIncompleteEntities", "description": "List of worksheets that were incomplete during the conversion." }, "post_upgrade_failed_entities": { "$ref": "#/components/schemas/ResponsePostUpgradeFailedEntities", "description": "List of worksheets that failed after an upgrade during the conversion process." } }, "description": "Name of the conversion process, which involves converting worksheets to models." }, "ResponseSuccessfulEntities": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseSuccessfulEntity" } } }, "description": "Wrapper for the successful entities, as they are inside a 'data' field in the response." }, "ResponseSuccessfulEntity": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the worksheet." } }, "description": "Unique ID of the worksheet." }, "ResponseFailedEntities": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseFailedEntity" } } }, "description": "Wrapper for the failed entities, as they are inside a 'data' field in the response." }, "ResponseFailedEntity": { "type": "object", "required": [ "id", "name", "error" ], "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the worksheet that failed to convert." }, "error": { "type": "string", "description": "Error details related to the failed conversion." } }, "description": "Unique ID of the failed worksheet." }, "ResponseIncompleteEntities": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseIncompleteEntity" } } }, "description": "Wrapper for the incomplete entities, as they are inside a 'data' field in the response." }, "ResponseIncompleteEntity": { "type": "object", "required": [ "id", "name", "error" ], "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the incomplete worksheet." }, "error": { "type": "string", "description": "Error details related to the incomplete conversion." } }, "description": "Unique ID of the incomplete worksheet." }, "ResponsePostUpgradeFailedEntities": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ResponsePostUpgradeFailedEntity" } } }, "description": "Wrapper for the post-upgrade failed entities, as they are inside a 'data' field in the response." }, "ResponsePostUpgradeFailedEntity": { "type": "object", "required": [ "id", "name", "error" ], "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "Name of the worksheet that failed post-upgrade." }, "error": { "type": "string", "description": "Error details related to the post-upgrade failure." } }, "description": "Unique ID of the worksheet that failed post-upgrade." }, "HeaderUpdateInput": { "type": "object", "required": [ "attributes" ], "properties": { "identifier": { "type": "string", "description": "Unique ID of a specified type to identify the header.", "nullable": true }, "obj_identifier": { "type": "string", "description": "Custom object identifier to uniquely identify header.", "nullable": true }, "type": { "type": "string", "enum": [ "ANSWER", "LOGICAL_TABLE", "LOGICAL_COLUMN", "LIVEBOARD", "ACTION_OBJECT", "DATA_SOURCE", "USER", "USER_GROUP", "COLLECTION", "ROLE", "TEMPLATE_VARIABLE" ], "description": "Optional type of the header object.", "nullable": true }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/HeaderAttributeInput" }, "description": "List of attributes to update" } }, "description": "Favorite object options." }, "HeaderAttributeInput": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "Attribute name to be updated." }, "value": { "type": "string", "description": "Attribute's new value." } }, "description": "Attribute to update in a header." }, "UpdateObjIdInput": { "type": "object", "required": [ "new_obj_id" ], "properties": { "metadata_identifier": { "type": "string", "description": "GUID or name of the metadata object.", "nullable": true }, "type": { "type": "string", "enum": [ "ANSWER", "LOGICAL_TABLE", "LOGICAL_COLUMN", "LIVEBOARD", "ACTION_OBJECT", "DATA_SOURCE", "USER", "USER_GROUP", "COLLECTION", "ROLE", "TEMPLATE_VARIABLE" ], "description": "Type of metadata. Required if metadata_identifier is name of the object.", "nullable": true }, "current_obj_id": { "type": "string", "description": "Current object ID value.", "nullable": true }, "new_obj_id": { "type": "string", "description": "New object ID value to set." } }, "description": "Input for updating object ID of a metadata object." }, "ExportMetadataTypeInput": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "CONNECTION", "CUSTOM_ACTION", "USER", "USER_GROUP", "ROLE", "FEEDBACK", "COLLECTION", "TEMPLATE_VARIABLE" ], "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.", "nullable": true }, "identifier": { "type": "string", "description": "Unique ID or name of the metadata object. Not required if the metadata type is ANSWER when session_id and generation_number is set.", "nullable": true }, "session_identifier": { "type": "string", "description": "Unique ID of the Answer session. Required if the metadata type is ANSWER and identifier is not set.", "nullable": true }, "generation_number": { "type": "integer", "format": "int32", "description": "Generation Number of the Answer session. Required if the metadata type is ANSWER and identifier is not set.", "nullable": true } }, "description": "MetadataType InputType used in Export MetadataType API" }, "DeleteMetadataTypeInput": { "type": "object", "required": [ "identifier" ], "properties": { "type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "LOGICAL_COLUMN", "LOGICAL_RELATIONSHIP" ], "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.", "nullable": true }, "identifier": { "type": "string", "description": "Unique ID or name of the metadata object." } }, "description": "MetadataType InputType used in Delete MetadataType API" }, "PublishMetadataListItem": { "type": "object", "required": [ "identifier" ], "properties": { "identifier": { "type": "string", "description": "Unique ID or name of the metadata." }, "type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE" ], "description": "Type of metadata. Required if identifier is name.", "nullable": true } } }, "AuthorMetadataTypeInput": { "type": "object", "required": [ "identifier" ], "properties": { "type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "CONNECTION" ], "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.", "nullable": true }, "identifier": { "type": "string", "description": "Unique ID or name of the metadata object." } }, "description": "MetadataType InputType used in Author API's" }, "ShareMetadataTypeInput": { "type": "object", "required": [ "identifier" ], "properties": { "type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "LOGICAL_COLUMN", "CONNECTION", "COLLECTION" ], "description": " Type of metadata.\n \n\nType of metadata. Required if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.", "nullable": true }, "identifier": { "type": "string", "description": "Unique ID or name of the metadata object." } } }, "SharePermissionsInput": { "type": "object", "required": [ "principal", "share_mode" ], "properties": { "principal": { "$ref": "#/components/schemas/PrincipalsInput", "description": "Details of users or groups." }, "share_mode": { "type": "string", "enum": [ "READ_ONLY", "MODIFY", "NO_ACCESS" ], "description": "Type of access to the shared object" }, "content_share_mode": { "type": "string", "enum": [ "READ_ONLY", "MODIFY" ], "description": "Content share mode for collections. Controls access to objects within the collection. Only applicable when sharing COLLECTION metadata type.", "nullable": true } } }, "ColumnSecurityRuleUpdate": { "type": "object", "required": [ "column_identifier" ], "properties": { "column_identifier": { "type": "string", "description": "Column identifier (col_id or name)" }, "is_unsecured": { "type": "boolean", "description": "If true, the column will be marked as unprotected and all groups associated with it will be removed", "nullable": true }, "group_access": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnSecurityRuleGroupOperation" }, "description": "Array of group operation objects that specifies the actions for groups to be associated with a column", "nullable": true } } }, "ColumnSecurityRuleGroupOperation": { "type": "object", "required": [ "operation", "group_identifiers" ], "properties": { "operation": { "type": "string", "enum": [ "ADD", "REMOVE", "REPLACE" ], "description": "Type of operation to be performed on the groups" }, "group_identifiers": { "type": "array", "items": { "type": "string" }, "description": "Array of group identifiers (name or GUID) on which the operation will be performed" } } }, "MetadataObject": { "type": "object", "required": [ "identifier" ], "properties": { "identifier": { "type": "string", "description": "Unique ID or name of the metadata" }, "type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "CUSTOM_ACTION" ], "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.", "nullable": true } } }, "CommitResponse": { "type": "object", "properties": { "committer": { "$ref": "#/components/schemas/CommiterType", "description": "Repository user using which changes were committed", "nullable": true }, "author": { "$ref": "#/components/schemas/AuthorType", "description": "Thoughtspot user who commits the changes", "nullable": true }, "comment": { "type": "string", "description": "Comments associated with the commit", "nullable": true }, "commit_time": { "type": "string", "description": "Time at which the changes were committed.", "nullable": true }, "commit_id": { "type": "string", "description": "SHA id associated with the commit", "nullable": true }, "branch": { "type": "string", "description": "Branch where changes were committed", "nullable": true }, "committed_files": { "type": "array", "items": { "$ref": "#/components/schemas/CommitFileType" }, "description": "Files that were pushed as part of this commit", "nullable": true } } }, "CommitFileType": { "type": "object", "required": [ "file_name", "status_code" ], "properties": { "file_name": { "type": "string", "description": "Name of the file deployed" }, "status_code": { "type": "string", "description": "Indicates the status of deployment for the file" }, "status_message": { "type": "string", "description": "Any error or warning with the deployment", "nullable": true } } }, "RevertResponse": { "type": "object", "properties": { "committer": { "$ref": "#/components/schemas/CommiterType", "description": "Repository user using which changes were committed", "nullable": true }, "author": { "$ref": "#/components/schemas/AuthorType", "description": "Thoughtspot user who commits the changes", "nullable": true }, "comment": { "type": "string", "description": "Comments associated with the commit", "nullable": true }, "commit_time": { "type": "string", "description": "Time at which the changes were committed.", "nullable": true }, "commit_id": { "type": "string", "description": "SHA id associated with the commit", "nullable": true }, "branch": { "type": "string", "description": "Branch where changes were committed", "nullable": true }, "committed_files": { "type": "array", "items": { "$ref": "#/components/schemas/CommitFileType" }, "description": "Files that were pushed as part of this commit", "nullable": true }, "reverted_metadata": { "type": "array", "items": { "$ref": "#/components/schemas/RevertedMetadata" }, "description": "Metadata of reverted file of this commit", "nullable": true } } }, "RevertedMetadata": { "type": "object", "required": [ "file_name", "metadata_name", "metadata_type", "status_code", "status_message" ], "properties": { "file_name": { "type": "string", "description": "Name of the file deployed" }, "metadata_name": { "type": "string", "description": "Name of the metadata object" }, "metadata_type": { "type": "string", "description": "Type of the metadata object" }, "status_code": { "type": "string", "description": "Indicates the status of deployment for the file" }, "status_message": { "type": "string", "description": "Any error or warning with the deployment" } } }, "DeployResponse": { "type": "object", "properties": { "file_name": { "type": "string", "description": "Name of the file deployed", "nullable": true }, "metadata_name": { "type": "string", "description": "Name of the metadata object", "nullable": true }, "metadata_type": { "type": "string", "description": "Type of the metadata object", "nullable": true }, "status_code": { "type": "string", "description": "Indicates the status of deployment for the file", "nullable": true }, "status_message": { "type": "string", "description": "Any error or warning with the deployment", "nullable": true } } }, "CreateConnectionResponse": { "type": "object", "required": [ "id", "name", "data_warehouse_type" ], "properties": { "id": { "type": "string", "description": "ID of the connection created." }, "name": { "type": "string", "description": "Name of the connection." }, "data_warehouse_type": { "type": "string", "enum": [ "SNOWFLAKE", "AMAZON_REDSHIFT", "GOOGLE_BIGQUERY", "AZURE_SYNAPSE", "TERADATA", "SAP_HANA", "STARBURST", "ORACLE_ADW", "DATABRICKS", "DENODO", "DREMIO", "TRINO", "PRESTO", "POSTGRES", "SQLSERVER", "MYSQL", "GENERIC_JDBC", "AMAZON_RDS_POSTGRESQL", "AMAZON_AURORA_POSTGRESQL", "AMAZON_RDS_MYSQL", "AMAZON_AURORA_MYSQL", "LOOKER", "AMAZON_ATHENA", "SINGLESTORE", "GCP_SQLSERVER", "GCP_ALLOYDB_POSTGRESQL", "GCP_POSTGRESQL", "GCP_MYSQL", "MODE", "GOOGLE_SHEETS", "FALCON", "FALCON_ONPREM", "CLICKHOUSE", "IOMETE" ], "description": "Type of data warehouse." }, "details": { "type": "object", "description": "Details of the connection.", "nullable": true } } }, "FetchConnectionDiffStatusResponse": { "type": "object", "properties": { "status": { "type": "boolean", "description": "Status of the connection diff.", "nullable": true } } }, "RevokeRefreshTokensResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "string", "description": "Result message describing the outcome of the refresh token revocation operation." } } }, "SyncMetadataResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "SUCCESS", "PARTIAL_SUCCESS", "NO_UPDATE" ], "description": "Overall status of the sync operation.", "nullable": true }, "tables_updated": { "type": "integer", "format": "int32", "description": "Number of tables with metadata updates.", "nullable": true }, "columns_updated": { "type": "integer", "format": "int32", "description": "Number of columns with metadata updates.", "nullable": true }, "tables_failed": { "type": "integer", "format": "int32", "description": "Number of tables that failed to sync (for PARTIAL_SUCCESS).", "nullable": true }, "columns_failed": { "type": "integer", "format": "int32", "description": "Number of columns that failed to sync (for PARTIAL_SUCCESS).", "nullable": true }, "message": { "type": "string", "description": "Message describing the result.", "nullable": true } }, "description": "Response from sync metadata operation." }, "RoleResponse": { "type": "object", "required": [ "id", "name", "description", "privileges" ], "properties": { "id": { "type": "string", "description": "Unique Id of the role." }, "name": { "type": "string", "description": "Name of the role" }, "description": { "type": "string", "description": "Description of the role" }, "groups_assigned_count": { "type": "integer", "format": "int32", "description": "number of groups assigned with this role", "nullable": true }, "orgs": { "type": "array", "items": { "$ref": "#/components/schemas/GenericInfo" }, "description": "Orgs in which role exists.", "nullable": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GenericInfo" }, "description": "Details of groups assigned with this role", "nullable": true }, "privileges": { "type": "array", "items": { "type": "string", "enum": [ "USERDATAUPLOADING", "DATADOWNLOADING", "DATAMANAGEMENT", "SHAREWITHALL", "JOBSCHEDULING", "A3ANALYSIS", "BYPASSRLS", "DISABLE_PINBOARD_CREATION", "DEVELOPER", "APPLICATION_ADMINISTRATION", "USER_ADMINISTRATION", "GROUP_ADMINISTRATION", "SYSTEM_INFO_ADMINISTRATION", "SYNCMANAGEMENT", "ORG_ADMINISTRATION", "ROLE_ADMINISTRATION", "AUTHENTICATION_ADMINISTRATION", "BILLING_INFO_ADMINISTRATION", "CONTROL_TRUSTED_AUTH", "TAGMANAGEMENT", "LIVEBOARD_VERIFIER", "CAN_MANAGE_CUSTOM_CALENDAR", "CAN_CREATE_OR_EDIT_CONNECTIONS", "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", "CAN_MANAGE_VERSION_CONTROL", "THIRDPARTY_ANALYSIS", "CAN_CREATE_CATALOG", "ALLOW_NON_EMBED_FULL_APP_ACCESS", "CAN_ACCESS_ANALYST_STUDIO", "CAN_MANAGE_ANALYST_STUDIO", "PREVIEW_DOCUMENT_SEARCH", "CAN_MANAGE_VARIABLES", "CAN_MODIFY_FOLDERS", "CAN_VIEW_FOLDERS", "CAN_MANAGE_AGENTSPOT", "CAN_ACCESS_AGENTSPOT", "CAN_SETUP_VERSION_CONTROL", "PREVIEW_THOUGHTSPOT_SAGE", "CAN_MANAGE_WEBHOOKS", "CAN_DOWNLOAD_VISUALS", "CAN_DOWNLOAD_DETAILED_DATA", "CAN_USE_SPOTTER", "CAN_MANAGE_SPOTTER", "CAN_CREATE_LIVEBOARD", "CAN_CREATE_ANSWERS", "CAN_ANALYZE_DATA", "CAN_ADMINISTER_SCHEDULES", "CAN_CREATE_KPI_ALERTS" ] }, "description": "Privileges granted to the role." }, "permission": { "type": "string", "enum": [ "READ_ONLY", "MODIFY", "NO_ACCESS" ], "description": "Permission details of the Role", "nullable": true }, "author_id": { "type": "string", "description": "Unique identifier of author of the role.", "nullable": true }, "modifier_id": { "type": "string", "description": "Unique identifier of modifier of the role.", "nullable": true }, "creation_time_in_millis": { "type": "object", "description": "Creation time of the role in milliseconds.", "nullable": true }, "modification_time_in_millis": { "type": "object", "description": "Last modified time of the role in milliseconds.", "nullable": true }, "deleted": { "type": "boolean", "description": "Indicates whether the role is deleted.", "nullable": true }, "deprecated": { "type": "boolean", "description": "Indicates whether the role is deprecated.", "nullable": true }, "external": { "type": "boolean", "description": "Indicates whether the role is external.", "nullable": true }, "hidden": { "type": "boolean", "description": "Indicates whether the role is hidden.", "nullable": true }, "shared_via_connection": { "type": "boolean", "description": "Indicates whether the role is shared via connection", "nullable": true } } }, "LiveboardOptionsInput": { "type": "object", "required": [ "visualization_identifiers" ], "properties": { "visualization_identifiers": { "type": "array", "items": { "type": "string" }, "description": "Unique ID or name of visualizations." } }, "description": "Options to specify details of Liveboard." }, "SchedulesPdfOptionsInput": { "type": "object", "properties": { "complete_liveboard": { "type": "boolean", "description": "Indicates whether to include complete Liveboard.", "nullable": true }, "include_cover_page": { "type": "boolean", "description": "Indicates whether to include cover page with the Liveboard title.", "nullable": true }, "include_custom_logo": { "type": "boolean", "description": "Indicates whether to include customized wide logo in the footer if available.", "nullable": true }, "include_filter_page": { "type": "boolean", "description": "Indicates whether to include a page with all applied filters.", "nullable": true }, "include_page_number": { "type": "boolean", "description": "Indicates whether to include page number in the footer of each page", "nullable": true }, "page_footer_text": { "type": "string", "description": "Text to include in the footer of each page.", "nullable": true }, "page_orientation": { "type": "string", "description": "Page orientation of the PDF.", "nullable": true }, "page_size": { "type": "string", "enum": [ "A4", "TAB_BASED" ], "description": "Page size.", "nullable": true }, "truncate_table": { "type": "boolean", "description": "Indicates whether to include only first page of the tables.", "nullable": true } }, "description": "Options for PDF export." }, "FrequencyInput": { "type": "object", "required": [ "cron_expression" ], "properties": { "cron_expression": { "$ref": "#/components/schemas/CronExpressionInput", "description": "Schedule selected cron expression." } }, "description": "Configuration of schedule with cron expression" }, "CronExpressionInput": { "type": "object", "required": [ "day_of_month", "day_of_week", "hour", "minute", "month", "second" ], "properties": { "day_of_month": { "type": "string", "description": "Day of month of the object." }, "day_of_week": { "type": "string", "description": "Day of Week of the object." }, "hour": { "type": "string", "description": "Hour of the object." }, "minute": { "type": "string", "description": "Minute of the object." }, "month": { "type": "string", "description": "Month of the object." }, "second": { "type": "string", "description": "Second of the object." } }, "description": "Schedule selected cron expression." }, "RecipientDetailsInput": { "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "string" }, "description": "Emails of the recipients.", "nullable": true }, "principals": { "type": "array", "items": { "$ref": "#/components/schemas/PrincipalsListItemInput" }, "description": "User or groups to be set as recipients of the schedule notifications.", "nullable": true } }, "description": "Recipients of the scheduled job notification." }, "PrincipalsListItemInput": { "type": "object", "required": [ "identifier", "type" ], "properties": { "identifier": { "type": "string", "description": "Unique ID or name of the user or group." }, "type": { "type": "string", "description": "Principal type." } } }, "ResponseSchedule": { "type": "object", "required": [ "author", "creation_time_in_millis", "file_format", "frequency", "id", "metadata", "name", "recipient_details", "time_zone" ], "properties": { "author": { "$ref": "#/components/schemas/Author", "description": "Author of the schedule." }, "creation_time_in_millis": { "type": "object", "description": "Schedule creation time in milliseconds." }, "description": { "type": "string", "description": "Description of the job.", "nullable": true }, "file_format": { "type": "string", "description": "Export file format." }, "frequency": { "$ref": "#/components/schemas/Frequency", "description": "Configuration of schedule with cron expression" }, "id": { "type": "string", "description": "GUID of the scheduled job." }, "liveboard_options": { "$ref": "#/components/schemas/LiveboardOptions", "description": "Options to specify details of Liveboard.", "nullable": true }, "metadata": { "$ref": "#/components/schemas/MetadataResponse", "description": "Unique ID or name of the metadata." }, "name": { "type": "string", "description": "Name of the scheduled job." }, "pdf_options": { "$ref": "#/components/schemas/PdfOptions", "description": "Options for PDF export.", "nullable": true }, "recipient_details": { "$ref": "#/components/schemas/RecipientDetails", "description": "Recipient of the scheduled job notifications." }, "status": { "type": "string", "description": "Status of the job", "nullable": true }, "time_zone": { "type": "string", "description": "Time zone" }, "history_runs": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseScheduleRun" }, "description": "Schedule runs history records.", "nullable": true }, "personalised_view_id": { "type": "string", "description": "Personalised view id of the liveboard to be scheduled.", "nullable": true } } }, "Author": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "The unique identifier of the object." }, "name": { "type": "string", "description": "Name of the object." } }, "description": "Author of the schedule." }, "Frequency": { "type": "object", "required": [ "cron_expression" ], "properties": { "cron_expression": { "$ref": "#/components/schemas/CronExpression", "description": "Schedule selected cron expression." } }, "description": "Configuration of schedule with cron expression" }, "CronExpression": { "type": "object", "required": [ "day_of_month", "day_of_week", "hour", "minute", "month", "second" ], "properties": { "day_of_month": { "type": "string", "description": "Day of month of the object." }, "day_of_week": { "type": "string", "description": "Day of Week of the object." }, "hour": { "type": "string", "description": "Hour of the object." }, "minute": { "type": "string", "description": "Minute of the object." }, "month": { "type": "string", "description": "Month of the object." }, "second": { "type": "string", "description": "Second of the object." } }, "description": "Schedule selected cron expression." }, "LiveboardOptions": { "type": "object", "required": [ "visualization_identifiers" ], "properties": { "visualization_identifiers": { "type": "array", "items": { "type": "string" }, "description": "Unique ID or name of visualizations." } }, "description": "Options to specify details of Liveboard." }, "MetadataResponse": { "type": "object", "required": [ "id", "type" ], "properties": { "name": { "type": "string", "nullable": true }, "id": { "type": "string" }, "type": { "type": "string", "enum": [ "LIVEBOARD" ] } } }, "PdfOptions": { "type": "object", "properties": { "complete_liveboard": { "type": "boolean", "description": "Indicates whether to include complete Liveboard.", "nullable": true }, "include_cover_page": { "type": "boolean", "description": "Indicates whether to include cover page with the Liveboard title.", "nullable": true }, "include_custom_logo": { "type": "boolean", "description": "Indicates whether to include customized wide logo in the footer if available.", "nullable": true }, "include_filter_page": { "type": "boolean", "description": "Indicates whether to include a page with all applied filters.", "nullable": true }, "include_page_number": { "type": "boolean", "description": "Indicates whether to include page number in the footer of each page", "nullable": true }, "page_footer_text": { "type": "string", "description": "Text to include in the footer of each page.", "nullable": true }, "page_orientation": { "type": "string", "description": "Page orientation of the PDF.", "nullable": true }, "page_size": { "type": "string", "enum": [ "A4", "TAB_BASED" ], "description": "Page size.", "nullable": true }, "truncate_table": { "type": "boolean", "description": "Indicates whether to include only first page of the tables.", "nullable": true } }, "description": "Options for PDF export." }, "RecipientDetails": { "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "string" }, "description": "Emails of the recipients. Specify email address if the recipient is not a ThoughtSpot user.", "nullable": true }, "principals": { "type": "array", "items": { "$ref": "#/components/schemas/PrincipalsListItem" }, "description": "List of user or groups to subscribe for the scheduled job notifications.", "nullable": true } }, "description": "Recipient configuration which includes email address, ID or name of the users and groups." }, "PrincipalsListItem": { "type": "object", "required": [ "identifier", "type" ], "properties": { "identifier": { "type": "string", "description": "Unique ID or name of the user or group." }, "type": { "type": "string", "description": "Principal type. Valid values are" } } }, "ResponseScheduleRun": { "type": "object", "required": [ "id", "start_time_in_millis", "end_time_in_millis", "status" ], "properties": { "id": { "type": "string", "description": "GUID of the scheduled job." }, "start_time_in_millis": { "type": "integer", "format": "int32", "description": "Schedule run start time in milliseconds." }, "end_time_in_millis": { "type": "integer", "format": "int32", "description": "Schedule run end time in milliseconds." }, "status": { "type": "string", "description": "Status of the schedule run." }, "detail": { "type": "string", "description": "Message details related to the schedule run.", "nullable": true } }, "description": "Schedule run response object" }, "MetadataInput": { "type": "object", "properties": { "identifier": { "type": "string", "nullable": true }, "type": { "type": "string", "enum": [ "LIVEBOARD" ], "nullable": true } } }, "SortingOptions": { "type": "object", "properties": { "field_name": { "type": "string", "description": "Name of the field to apply the sort on.", "nullable": true }, "order": { "type": "string", "description": "Sort order : ASC(Ascending) or DESC(Descending).", "nullable": true } }, "description": "Sort options." }, "ScheduleHistoryRunsOptionsInput": { "type": "object", "properties": { "include_history_runs": { "type": "boolean", "default": false, "description": "Indicates whether to fetch history runs for the scheduled notification.", "nullable": true }, "record_size": { "type": "integer", "format": "int32", "default": 10, "description": "Indicates the max number of records that can be fetched as past runs of any scheduled job.", "nullable": true }, "record_offset": { "type": "integer", "format": "int32", "default": 0, "description": "Indicates the starting record number from where history runs records should be fetched.", "nullable": true } } }, "Action_Details_Input_Create": { "type": "object", "properties": { "CALLBACK": { "$ref": "#/components/schemas/CALLBACKInputMandatory", "description": "CALLBACK Custom Action Type", "nullable": true }, "URL": { "$ref": "#/components/schemas/URLInputMandatory", "description": "URL Custom Action Type", "nullable": true } }, "description": "Action details includes Type and Configuration for Custom Actions, either Callback or URL is required.\nWhen both callback and url are provided, callback would be considered" }, "CALLBACKInputMandatory": { "type": "object", "properties": { "reference": { "type": "string", "description": "Reference name. By default, the value will be set to action name.", "nullable": true } }, "description": "CALLBACK Custom Action Type" }, "URLInputMandatory": { "type": "object", "required": [ "url" ], "properties": { "authentication": { "$ref": "#/components/schemas/AuthenticationInput", "description": "Authorization type for the custom action.", "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ParametersListItemInput" }, "description": "Query parameters for url.", "nullable": true }, "url": { "type": "string", "description": "Request Url for the Custom action." }, "reference": { "type": "string", "description": "Reference name. By default the value will be set to action name", "nullable": true } }, "description": "URL Custom Action Type" }, "AuthenticationInput": { "type": "object", "properties": { "API_Key": { "$ref": "#/components/schemas/API_KeyInput", "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters.", "nullable": true }, "Basic_Auth": { "$ref": "#/components/schemas/Basic_AuthInput", "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request.", "nullable": true }, "Bearer_Token": { "type": "string", "description": "Bearer tokens enable requests to authenticate using an access key.", "nullable": true }, "No_Auth": { "type": "string", "description": "No authorization. If your request doesn't require authorization.", "nullable": true } }, "description": "Authorization type for the custom action." }, "API_KeyInput": { "type": "object", "properties": { "key": { "type": "string", "description": "Enter your key name", "nullable": true }, "value": { "type": "string", "description": "Enter you key value", "nullable": true } }, "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters." }, "Basic_AuthInput": { "type": "object", "properties": { "password": { "type": "string", "description": "Password for the basic authentication", "nullable": true }, "username": { "type": "string", "description": "Username for the basic authentication", "nullable": true } }, "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request." }, "ParametersListItemInput": { "type": "object", "properties": { "key": { "type": "string", "description": "Key for the url query parameter", "nullable": true }, "value": { "type": "string", "description": "Value for the url query parameter", "nullable": true } } }, "Associate_Metadata_Input_Create": { "type": "object", "required": [ "identifier" ], "properties": { "action_config": { "$ref": "#/components/schemas/ActionConfigInputCreate", "description": "Specify that the association is enabled for the metadata object", "nullable": true }, "identifier": { "type": "string", "description": "Unique ID or name of the metadata." }, "type": { "type": "string", "enum": [ "VISUALIZATION", "ANSWER", "WORKSHEET" ], "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.", "nullable": true } } }, "ActionConfigInputCreate": { "type": "object", "properties": { "position": { "type": "string", "enum": [ "MENU", "PRIMARY", "CONTEXT_MENU" ], "default": "MENU", "description": "Position of the Custom action on the Metadata object. Earlier naming convention: context.", "nullable": true }, "visibility": { "type": "boolean", "default": true, "description": "Visibility of the metadata association with custom action. Earlier naming convention: enabled", "nullable": true } }, "description": "Specify that the association is enabled for the metadata object Default" }, "Default_Action_Config_Input_Create": { "type": "object", "properties": { "visibility": { "type": "boolean", "default": true, "description": "Custom action is available on all visualizations. Earlier naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.\nDefault: true", "nullable": true } }, "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers." }, "Action_Details_Input": { "type": "object", "properties": { "CALLBACK": { "$ref": "#/components/schemas/CALLBACKInput", "description": "CALLBACK Custom Action Type", "nullable": true }, "URL": { "$ref": "#/components/schemas/URLInput", "description": "URL Custom Action Type", "nullable": true } }, "description": "Action details includes `Type` and configuration details of Custom Actions. Either Callback or URL is required." }, "CALLBACKInput": { "type": "object", "properties": { "reference": { "type": "string", "description": "Reference name. By default, the value will be set to action name.", "nullable": true } }, "description": "CALLBACK Custom Action Type" }, "URLInput": { "type": "object", "properties": { "authentication": { "$ref": "#/components/schemas/AuthenticationInput", "description": "Authorization type for the custom action.", "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ParametersListItemInput" }, "description": "Query parameters for url.", "nullable": true }, "url": { "type": "string", "description": "Request Url for the Custom action.", "nullable": true }, "reference": { "type": "string", "description": "Reference name. By default the value will be set to action name", "nullable": true } }, "description": "URL Custom Action Type" }, "Associate_Metadata_Input": { "type": "object", "properties": { "action_config": { "$ref": "#/components/schemas/ActionConfigInput", "description": "Specify that the association is enabled for the metadata object", "nullable": true }, "identifier": { "type": "string", "description": "Unique ID or name of the metadata.", "nullable": true }, "type": { "type": "string", "enum": [ "VISUALIZATION", "ANSWER", "WORKSHEET" ], "description": " Type of metadata.\n \n\nRequired if the name of the object is set as the identifier. This attribute is optional when the object GUID is specified as the identifier.", "nullable": true } } }, "ActionConfigInput": { "type": "object", "properties": { "position": { "type": "string", "enum": [ "MENU", "PRIMARY", "CONTEXT_MENU" ], "description": "Position of the Custom action on the Metadata object. Earlier naming convention: context.", "nullable": true }, "visibility": { "type": "boolean", "description": "Visibility of the metadata association with custom action. Earlier naming convention: enabled", "nullable": true } }, "description": "Specify that the association is enabled for the metadata object Default" }, "Default_Action_Config_Input": { "type": "object", "properties": { "visibility": { "type": "boolean", "description": "Custom action is available on all visualizations. Earlier naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.", "nullable": true } }, "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers." }, "ModelTableList": { "type": "object", "required": [ "model_name", "tables" ], "properties": { "model_name": { "type": "string", "description": "Name of the Model." }, "model_path": { "type": "string", "description": "Model directory path, this is optional param and required if there are duplicate models with the same name.", "nullable": true }, "tables": { "type": "array", "items": { "type": "string" }, "description": "List of Tables." } } }, "DbtSearchResponse": { "type": "object", "properties": { "dbt_connection_identifier": { "type": "string", "nullable": true }, "project_name": { "type": "string", "nullable": true }, "connection_id": { "type": "string", "nullable": true }, "connection_name": { "type": "string", "nullable": true }, "cdw_database": { "type": "string", "nullable": true }, "import_type": { "type": "string", "nullable": true }, "author_name": { "type": "string", "nullable": true } } }, "Conversation": { "type": "object", "required": [ "conversation_identifier" ], "properties": { "conversation_identifier": { "type": "string", "description": "Unique identifier of the conversation." } } }, "ResponseMessage": { "type": "object", "required": [ "message_type" ], "properties": { "session_identifier": { "type": "string", "description": "Unique identifier of the generated response.", "nullable": true }, "generation_number": { "type": "integer", "format": "int32", "description": "Generate number of the response.", "nullable": true }, "message_type": { "type": "string", "enum": [ "TSAnswer" ], "description": "Type of the generated response." }, "visualization_type": { "type": "string", "enum": [ "Chart", "CHART", "Table", "TABLE", "Undefined", "UNDEFINED" ], "description": "Generated visualization type.", "nullable": true }, "tokens": { "type": "string", "description": "Tokens for the response.", "nullable": true }, "display_tokens": { "type": "string", "description": "User friendly tokens for the response.", "nullable": true } } }, "ContextPayloadV2Input": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "data_source", "DATA_SOURCE", "AUTO_MODE" ], "description": "Type of the context.", "nullable": true }, "data_source_context": { "$ref": "#/components/schemas/DataSourceContextInput", "description": "Data source context.", "nullable": true } } }, "DataSourceContextInput": { "type": "object", "properties": { "data_source_identifier": { "type": "string", "description": "Unique identifier of the data source.\nRequired when context type is DATA_SOURCE and `data_source_identifiers` is not provided.\nAt least one of `data_source_identifier` or `data_source_identifiers` must be supplied for DATA_SOURCE context;\nomit only when context type is AUTO_MODE.
Version: 26.5.0.cl or later", "nullable": true }, "data_source_identifiers": { "type": "array", "items": { "type": "string" }, "description": "Unique identifiers of data sources for multi-data-source context.\nRequired when context type is DATA_SOURCE and `data_source_identifier` is not provided.
Version: 26.5.0.cl or later", "nullable": true }, "guid": { "type": "string", "description": "Deprecated. Use `data_source_identifier` instead.\nPreviously required when neither `data_source_identifier` nor `data_source_identifiers` was provided for DATA_SOURCE context.
Version: 26.2.0.cl or later", "nullable": true } } }, "ConversationSettingsInput": { "type": "object", "properties": { "enable_contextual_change_analysis": { "type": "boolean", "default": true, "description": "Enable contextual change analysis.\nDefault changed from `false` to `true` in 26.2.0.cl.\nIgnored on versions >= 26.2.0.cl where it is always enabled.
Version: 10.4.0.cl or later", "nullable": true }, "enable_natural_language_answer_generation": { "type": "boolean", "default": true, "description": "Enable natural language to answer generation.\nDefault changed from `false` to `true` in 26.2.0.cl.\nIgnored on versions >= 26.2.0.cl where it is always enabled.
Version: 10.4.0.cl or later", "nullable": true }, "enable_reasoning": { "type": "boolean", "default": true, "description": "Enable reasoning.\nDefault changed from `false` to `true` in 26.2.0.cl.\nIgnored on versions >= 26.2.0.cl where it is always enabled.
Version: 10.4.0.cl or later", "nullable": true }, "enable_save_chat": { "type": "boolean", "default": false, "description": "Enable save conversation. When `true`, the conversation is persisted\nand can be retrieved later via conversation history.
Version: 26.5.0.cl or later", "nullable": true } } }, "AgentConversation": { "type": "object", "required": [ "conversation_id", "conversation_identifier" ], "properties": { "conversation_id": { "type": "string", "description": "Unique identifier of the conversation." }, "conversation_identifier": { "type": "string", "description": "Unique identifier of the conversation.
Version: 26.5.0.cl or later" }, "analyst_id": { "type": "string", "description": "Unique identifier of the Spotter Analyst the conversation was started\nfrom. Null when the conversation was not started from an analyst.
Version: 26.10.0.cl or later", "nullable": true } } }, "SendAgentMessageResponse": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean", "description": "Indicates whether the agent response was received and processed successfully." }, "message": { "type": "string", "description": "Optional message providing additional context about the operation outcome.", "nullable": true } } }, "NLInstructionsInfoInput": { "type": "object", "required": [ "instructions", "scope" ], "properties": { "instructions": { "type": "array", "items": { "type": "string" }, "description": "User instructions for natural language processing." }, "scope": { "type": "string", "enum": [ "GLOBAL" ], "description": "Scope of the instruction (USER or GLOBAL). Defaults to GLOBAL." } } }, "eureka_SetNLInstructionsResponse": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean", "description": "Success status of the operation." } } }, "AnalystSourceInput": { "type": "object", "required": [ "identifier", "type" ], "properties": { "identifier": { "type": "string", "description": "Unique identifier of the data source." }, "name": { "type": "string", "description": "Display name of the data source.", "nullable": true }, "type": { "type": "string", "enum": [ "MODEL", "ANSWER", "LIVEBOARD", "CONVERSATION" ], "description": "Type of the data source." } }, "description": "A data source to attach to a Spotter Analyst." }, "Analyst": { "type": "object", "required": [ "id", "sources", "mcp_connectors", "starter_prompts" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the analyst." }, "name": { "type": "string", "description": "Display name of the analyst.", "nullable": true }, "description": { "type": "string", "description": "Description of the analyst.", "nullable": true }, "instructions": { "type": "string", "description": "Natural-language instructions that guide the agent's behavior for this\nanalyst.", "nullable": true }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/AnalystSource" }, "description": "Data sources the analyst can query." }, "mcp_connectors": { "type": "array", "items": { "type": "string" }, "description": "IDs of MCP connectors linked to this analyst." }, "starter_prompts": { "type": "array", "items": { "$ref": "#/components/schemas/AnalystStarterPrompt" }, "description": "User-defined starter prompts, in display order." }, "updated_time_in_millis": { "type": "object", "description": "Epoch milliseconds of the last update.", "nullable": true }, "created_by": { "type": "string", "description": "ID of the user who created the analyst.", "nullable": true }, "updated_by": { "type": "string", "description": "ID of the user who last updated the analyst.", "nullable": true } }, "description": "A Spotter Analyst: a configured agent with a name, description, agent\ninstructions, data sources, MCP connectors, and starter prompts." }, "AnalystSource": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the data source." }, "type": { "type": "string", "enum": [ "MODEL", "ANSWER", "LIVEBOARD", "CONVERSATION" ], "description": "Type of the data source." } }, "description": "A data source attached to a Spotter Analyst." }, "AnalystStarterPrompt": { "type": "object", "required": [ "label", "text", "order", "is_ai_generated" ], "properties": { "label": { "type": "string", "description": "Short display label shown in the UI." }, "text": { "type": "string", "description": "Full prompt text sent to the agent." }, "order": { "type": "integer", "format": "int32", "description": "Display order within the list." }, "is_ai_generated": { "type": "boolean", "description": "Whether this prompt was AI-generated." } }, "description": "A user-defined starter prompt shown on the Analyst landing page." }, "AnalystDeleteResponse": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the deleted analyst." } }, "description": "Response returned after deleting a Spotter Analyst." }, "AnalystSearchResponse": { "type": "object", "required": [ "analysts", "total_size" ], "properties": { "analysts": { "type": "array", "items": { "$ref": "#/components/schemas/AnalystItem" }, "description": "Page of analysts matching the request." }, "total_size": { "type": "integer", "format": "int32", "description": "Total number of matches before pagination." } }, "description": "Response returned by analyst search." }, "AnalystItem": { "type": "object", "required": [ "id", "sources", "mcp_connectors", "icon_id", "starter_prompts" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the analyst." }, "name": { "type": "string", "description": "Display name of the analyst.", "nullable": true }, "description": { "type": "string", "description": "Description of the analyst.", "nullable": true }, "instructions": { "type": "string", "description": "Natural-language instructions that guide the agent's behavior for this\nanalyst.", "nullable": true }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/AnalystItemSource" }, "description": "Data sources the analyst can query." }, "mcp_connectors": { "type": "array", "items": { "$ref": "#/components/schemas/AnalystMcpConnector" }, "description": "MCP connectors linked to this analyst." }, "icon_id": { "type": "string", "description": "Icon identifier. Empty string means the default icon." }, "starter_prompts": { "type": "array", "items": { "$ref": "#/components/schemas/AnalystItemStarterPrompt" }, "description": "Starter prompts in display order, including the fixed prompt." }, "updated_time_in_millis": { "type": "object", "description": "Epoch milliseconds of the last update.", "nullable": true }, "last_accessed_time_in_millis": { "type": "object", "description": "Epoch milliseconds of the caller's last interaction with the analyst.", "nullable": true }, "created_by": { "$ref": "#/components/schemas/AnalystUser", "description": "User who created the analyst.", "nullable": true }, "updated_by": { "$ref": "#/components/schemas/AnalystUser", "description": "User who last updated the analyst.", "nullable": true } }, "description": "A Spotter Analyst as returned in search results." }, "AnalystItemSource": { "type": "object", "required": [ "id", "type" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the data source." }, "type": { "type": "string", "enum": [ "MODEL", "ANSWER", "LIVEBOARD", "CONVERSATION" ], "description": "Type of the data source." }, "name": { "type": "string", "description": "Display name of the data source.", "nullable": true } }, "description": "A data source returned in analyst search results." }, "AnalystMcpConnector": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the MCP connector." }, "name": { "type": "string", "description": "Name of the MCP connector.", "nullable": true }, "icon_url": { "type": "string", "description": "Icon URL of the MCP connector.", "nullable": true } }, "description": "An MCP connector returned in analyst search results." }, "AnalystItemStarterPrompt": { "type": "object", "required": [ "label", "text", "order", "is_fixed" ], "properties": { "label": { "type": "string", "description": "Short display label shown in the UI." }, "text": { "type": "string", "description": "Full prompt text sent to the agent." }, "order": { "type": "integer", "format": "int32", "description": "Display order within the list." }, "is_fixed": { "type": "boolean", "description": "Whether this is the server-managed fixed prompt." } }, "description": "A starter prompt returned in analyst search results. Includes the\nserver-managed fixed prompt (`is_fixed: true`, order 0)." }, "AnalystUser": { "type": "object", "required": [ "id", "name", "display_name" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the user." }, "name": { "type": "string", "description": "Username of the user." }, "display_name": { "type": "string", "description": "Display name of the user." } }, "description": "A user reference returned in analyst search results." }, "PrincipalRefInput": { "type": "object", "required": [ "principal_identifier", "principal_type" ], "properties": { "principal_identifier": { "type": "string", "description": "Unique identifier of the user or group." }, "principal_type": { "type": "string", "enum": [ "USER", "USER_GROUP" ], "description": "Whether the principal is an individual user or a group." } }, "description": "Input reference to a principal (user or group) used when granting or revoking\naccess to a shared resource." }, "ImportMemoryResponse": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "string", "enum": [ "SUCCESS", "VALIDATION_FAILED", "FAILED" ], "description": "Terminal status of the import." }, "summary": { "type": "array", "items": { "$ref": "#/components/schemas/ImportSummary" }, "description": "Per (memory type, target source) result entries. Null when the\nimport failed before any record processing occurred.", "nullable": true }, "validation_failures": { "type": "array", "items": { "$ref": "#/components/schemas/ImportFailure" }, "description": "Per-item validation failure entries. Null when the import failed\nbefore item validation could run.", "nullable": true }, "diagnostics": { "type": "array", "items": { "$ref": "#/components/schemas/ImportDiagnostic" }, "description": "Diagnostic message groups (errors, rollbacks, and non-fatal\nwarnings), each keyed by a `sub_status`. Null when the import\nproduced no diagnostics.", "nullable": true }, "operation_id": { "type": "string", "description": "Server-generated identifier for this import operation. Include it in\nsupport tickets to help correlate server-side logs.", "nullable": true } }, "description": "Response from importMemory. On `SUCCESS`, `summary` is fully\npopulated. `diagnostics` carries any fatal errors, rollbacks, and\nnon-fatal warnings produced during the import." }, "ImportSummary": { "type": "object", "properties": { "memory_type": { "type": "string", "enum": [ "RULES", "RECIPES", "ALWAYS_APPLY_RULES" ], "description": "The kind of memory (`RULES`, `RECIPES`, or `ALWAYS_APPLY_RULES`)\nthese counts apply to.", "nullable": true }, "source": { "$ref": "#/components/schemas/ImportTargetSource", "description": "The target object these counts apply to.", "nullable": true }, "existing_record_count": { "type": "integer", "format": "int32", "description": "Number of memory entries of this type that already existed on the\ntarget object before the import.", "nullable": true }, "deleted_record_count": { "type": "integer", "format": "int32", "description": "Number of existing entries that will be (DRY_RUN) or were\n(EXECUTE_IMPORT) deleted as part of the replacement.", "nullable": true }, "inserted_record_count": { "type": "integer", "format": "int32", "description": "Number of entries from the payload that will be (DRY_RUN) or were\n(EXECUTE_IMPORT) inserted.", "nullable": true }, "failed_record_count": { "type": "integer", "format": "int32", "description": "Number of records of this type that failed validation or processing.", "nullable": true } }, "description": "Per (memory type, target source) summary of what importMemory did — or\nwould do, in DRY_RUN. `deleted_record_count` and `inserted_record_count`\nare previews in DRY_RUN and actuals in EXECUTE_IMPORT." }, "ImportTargetSource": { "type": "object", "properties": { "identifier": { "type": "string", "description": "Identifier (GUID) of the target object these counts apply to.", "nullable": true }, "type": { "type": "string", "enum": [ "DATA_MODEL" ], "description": "Source object kind (`DATA_MODEL`).", "nullable": true } }, "description": "Identifies the target object a group of import counts applies to.\n`type` is the source kind (`DATA_MODEL`) and `identifier` is\nthe object's GUID." }, "ImportFailure": { "type": "object", "properties": { "line_number": { "type": "integer", "format": "int32", "description": "Best-effort line number of the offending item in the uploaded YAML. May be null when the line cannot be\ndetermined.", "nullable": true }, "reason": { "type": "string", "enum": [ "UNKNOWN_FAILURE_REASON", "VALIDATION", "UNRESOLVED_SOURCE", "ACCESS_DENIED", "CHAR_LIMIT", "SCHEMA" ], "description": "Machine-readable category for the failure (e.g. `VALIDATION`,\n`ACCESS_DENIED`, `CHAR_LIMIT`).", "nullable": true }, "field_name": { "type": "string", "description": "Dotted path to the offending field within the item (e.g.\n`content.rule_definition`) for inline highlighting. Absent when the\nfailure is item-level rather than field-level.", "nullable": true }, "message": { "type": "string", "description": "Human-readable description of the failure.", "nullable": true } }, "description": "One per-item import failure surfaced by importMemory. `line_number` is\nthe best-effort line number in the uploaded YAML; `field_name` is a\ndotted path within the item (e.g. `content.rule_definition`) for inline\nhighlighting; absent when the failure is item-level rather than field-level." }, "ImportDiagnostic": { "type": "object", "properties": { "sub_status": { "type": "string", "enum": [ "UNKNOWN", "FAILURE", "WARNING", "ROLLED_BACK" ], "description": "Severity / disposition category these messages share (e.g.\n`WARNING`, `FAILURE`, `ROLLED_BACK`).", "nullable": true }, "messages": { "type": "array", "items": { "type": "string" }, "description": "Human-readable messages for this category (e.g. the details of a\n`WARNING`, or the failure cause for a `FAILURE`).", "nullable": true } }, "description": "A group of importMemory diagnostic messages that share a severity /\ndisposition. This is the single, uniform channel for fatal errors,\nrollbacks, and non-fatal observations." }, "VariableUpdateAssignmentInput": { "type": "object", "required": [ "variable_identifier", "variable_values", "operation" ], "properties": { "variable_identifier": { "type": "string", "description": "ID, name, or object ID of the variable" }, "variable_values": { "type": "array", "items": { "type": "string" }, "description": "Values of the variable" }, "operation": { "type": "string", "enum": [ "ADD", "REMOVE", "REPLACE", "RESET" ], "description": "Operation to perform" } }, "description": "Input for variable value update in batch operations" }, "VariableUpdateScopeInput": { "type": "object", "required": [ "org_identifier" ], "properties": { "org_identifier": { "type": "string", "description": "The unique name of the org" }, "principal_type": { "type": "string", "enum": [ "USER", "USER_GROUP" ], "description": "Type of principal to which the variable value applies. Use USER to assign values to a specific user, or USER_GROUP to assign values to a group.", "nullable": true }, "principal_identifier": { "type": "string", "description": "Unique ID or name of the principal", "nullable": true }, "model_identifier": { "type": "string", "description": "Unique ID or name of the model. Required for FORMULA_VARIABLE type to scope the variable value to a specific worksheet.", "nullable": true }, "priority": { "type": "integer", "format": "int32", "description": "The priority level for this scope assignment, used for conflict resolution when multiple values match. Higher priority values (larger numbers) take precedence.", "nullable": true } }, "description": "Input for defining the scope of variable value assignments in batch update operations" }, "VariablePutAssignmentInput": { "type": "object", "required": [ "assigned_values" ], "properties": { "assigned_values": { "type": "array", "items": { "type": "string" }, "description": "Values of the variable" }, "org_identifier": { "type": "string", "description": "The unique name of the org", "nullable": true }, "principal_type": { "type": "string", "enum": [ "USER", "USER_GROUP" ], "description": "Principal type", "nullable": true }, "principal_identifier": { "type": "string", "description": "Unique ID or name of the principal", "nullable": true }, "model_identifier": { "type": "string", "description": "Unique ID of the model", "nullable": true }, "priority": { "type": "integer", "format": "int32", "description": "Priority level", "nullable": true } }, "description": "Input for variable value put operations" }, "CreateEmailCustomizationResponse": { "type": "object", "required": [ "tenant_id", "org", "name", "template_properties" ], "properties": { "tenant_id": { "type": "string", "description": "Tenant ID" }, "org": { "$ref": "#/components/schemas/OrgType", "description": "Email customization org" }, "name": { "type": "string", "description": "Email customization name." }, "template_properties": { "type": "object", "description": "Customization configuration for the email" } } }, "OrgType": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "id": { "type": "integer", "format": "int32", "nullable": true } } }, "Template_Properties_Input_Create": { "type": "object", "properties": { "cta_button_bg_color": { "type": "string", "description": "Background color for call-to-action button in hex format", "nullable": true }, "cta_text_font_color": { "type": "string", "description": "Text color for call-to-action button in hex format", "nullable": true }, "primary_bg_color": { "type": "string", "description": "Primary background color in hex format", "nullable": true }, "home_url": { "type": "string", "description": "Home page URL (HTTP/HTTPS only)", "nullable": true }, "logo_url": { "type": "string", "description": "Logo image URL (HTTP/HTTPS only)", "nullable": true }, "font_family": { "type": "string", "description": "Font family for email content (e.g., Arial, sans-serif)", "nullable": true }, "product_name": { "type": "string", "description": "Product name to display", "nullable": true }, "footer_address": { "type": "string", "description": "Footer address text", "nullable": true }, "footer_phone": { "type": "string", "description": "Footer phone number", "nullable": true }, "replacement_value_for_liveboard": { "type": "string", "description": "Replacement value for Liveboard", "nullable": true }, "replacement_value_for_answer": { "type": "string", "description": "Replacement value for Answer", "nullable": true }, "replacement_value_for_spot_iq": { "type": "string", "description": "Replacement value for SpotIQ", "nullable": true }, "hide_footer_address": { "type": "boolean", "description": "Whether to hide footer address", "nullable": true }, "hide_footer_phone": { "type": "boolean", "description": "Whether to hide footer phone number", "nullable": true }, "hide_manage_notification": { "type": "boolean", "description": "Whether to hide manage notification link", "nullable": true }, "hide_mobile_app_nudge": { "type": "boolean", "description": "Whether to hide mobile app nudge", "nullable": true }, "hide_privacy_policy": { "type": "boolean", "description": "Whether to hide privacy policy link", "nullable": true }, "hide_product_name": { "type": "boolean", "description": "Whether to hide product name", "nullable": true }, "hide_ts_vocabulary_definitions": { "type": "boolean", "description": "Whether to hide ThoughtSpot vocabulary definitions", "nullable": true }, "hide_notification_status": { "type": "boolean", "description": "Whether to hide notification status", "nullable": true }, "hide_error_message": { "type": "boolean", "description": "Whether to hide error message", "nullable": true }, "hide_unsubscribe_link": { "type": "boolean", "description": "Whether to hide unsubscribe link", "nullable": true }, "hide_modify_alert": { "type": "boolean", "description": "Whether to hide modify alert", "nullable": true }, "company_privacy_policy_url": { "type": "string", "description": "Company privacy policy URL (HTTP/HTTPS only)", "nullable": true }, "company_website_url": { "type": "string", "description": "Company website URL (HTTP/HTTPS only)", "nullable": true }, "contact_support_url": { "type": "string", "description": "Contact support url (HTTP/HTTPS only).
Version: 26.2.0.cl or later", "nullable": true }, "hide_contact_support_url": { "type": "boolean", "description": "Whether to hide contact support url.
Version: 26.2.0.cl or later", "nullable": true }, "hide_logo_url": { "type": "boolean", "description": "Whether to hide logo
Version: 26.4.0.cl or later", "nullable": true } }, "description": "Email customization configuration properties" }, "ExternalTableInput": { "type": "object", "required": [ "connection_identifier", "table_name" ], "properties": { "connection_identifier": { "type": "string", "description": "Unique ID or name of the connection." }, "database_name": { "type": "string", "default": "", "description": "Name of the database.", "nullable": true }, "schema_name": { "type": "string", "default": "", "description": "Name of the schema.", "nullable": true }, "table_name": { "type": "string", "description": "Name of the table. Table names may be case-sensitive depending on the database system." } } }, "InputTableDefinitionInput": { "type": "object", "required": [ "new_columns", "referenced_columns" ], "properties": { "new_columns": { "type": "array", "items": { "$ref": "#/components/schemas/InputColumnSchemaInput" }, "description": "New input-only columns to create in the table." }, "referenced_columns": { "type": "array", "items": { "type": "string" }, "description": "Column IDs from the linked model to include in the table.\nPass an empty array to create an input table with no reference\ncolumns from the model." } }, "description": "Definition of the input table schema." }, "InputColumnSchemaInput": { "type": "object", "required": [ "name", "data_type", "type" ], "properties": { "name": { "type": "string", "description": "Name of the column." }, "data_type": { "type": "string", "description": "Physical data type of the column as recognized by the connected\nwarehouse (for example, VARCHAR, INT64, DOUBLE, BOOL, DATE).\nThe accepted values depend on the underlying Cloud Data Warehouse." }, "type": { "type": "string", "enum": [ "ATTRIBUTE", "MEASURE" ], "description": "Semantic role of the column in ThoughtSpot. Use ATTRIBUTE for\ndimensional data such as text, dates, and identifiers, and\nMEASURE for numeric or aggregatable values." }, "allowed_values": { "type": "array", "items": { "type": "string" }, "description": "Optional list of permitted values for the column. When provided,\ndata written to this column is restricted to these values. Omit\nor leave empty to allow any value supported by the data type.
Version: 26.9.0.cl or later", "nullable": true } }, "description": "Schema definition for a single input column." }, "InputTableResponse": { "type": "object", "properties": { "input_table_identifier": { "type": "string", "description": "Unique ID of the newly created input table.", "nullable": true } } }, "InputTableUpdateResponse": { "type": "object", "properties": { "rows_loaded": { "type": "integer", "format": "int32", "description": "Number of rows successfully written to the input table.", "nullable": true } }, "description": "Response returned after successfully writing rows to an input table." }, "PolicyProcessOptionsInput": { "type": "object", "properties": { "impersonate_user": { "type": "string", "nullable": true } } }, "WebhookAuthenticationInput": { "type": "object", "properties": { "API_KEY": { "$ref": "#/components/schemas/WebhookAuthApiKeyInput", "description": "API key authentication configuration.", "nullable": true }, "BASIC_AUTH": { "$ref": "#/components/schemas/WebhookAuthBasicAuthInput", "description": "Basic authentication configuration.", "nullable": true }, "BEARER_TOKEN": { "type": "string", "description": "Bearer token authentication configuration.", "nullable": true }, "OAUTH2": { "$ref": "#/components/schemas/WebhookAuthOAuth2Input", "description": "OAuth2 authentication configuration.", "nullable": true } } }, "WebhookAuthApiKeyInput": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "description": "The header or query parameter name for the API key." }, "value": { "type": "string", "description": "The API key value." } } }, "WebhookAuthBasicAuthInput": { "type": "object", "required": [ "username", "password" ], "properties": { "username": { "type": "string", "description": "Username for basic authentication." }, "password": { "type": "string", "description": "Password for basic authentication." } } }, "WebhookAuthOAuth2Input": { "type": "object", "required": [ "authorization_url", "client_id", "client_secret" ], "properties": { "authorization_url": { "type": "string", "description": "OAuth2 authorization server URL." }, "client_id": { "type": "string", "description": "OAuth2 client identifier." }, "client_secret": { "type": "string", "description": "OAuth2 client secret key." } } }, "WebhookSignatureVerificationInput": { "type": "object", "required": [ "type", "header", "algorithm", "secret" ], "properties": { "type": { "type": "string", "enum": [ "HMAC_SHA256" ], "description": "Signature verification method type." }, "header": { "type": "string", "description": "HTTP header where the signature is sent." }, "algorithm": { "type": "string", "enum": [ "SHA256" ], "description": "Hash algorithm used for signature verification." }, "secret": { "type": "string", "description": "Shared secret used for HMAC signature generation." } } }, "StorageDestinationInput": { "type": "object", "required": [ "storage_type", "storage_config" ], "properties": { "storage_type": { "type": "string", "enum": [ "AWS_S3", "GCP_GCS" ], "description": "Type of storage destination.\nExample: \"AWS_S3\"" }, "storage_config": { "$ref": "#/components/schemas/StorageConfigInput", "description": "Storage-specific configuration settings.\nExample: {\"aws_s3_config\": {\"bucket_name\": \"my-webhook-files\", \"region\": \"us-west-2\", \"role_arn\": \"arn:aws:iam::123456789012:role/WebhookDeliveryRole\", \"external_id\": \"ts-webhook-a1b2c3d4-7890\", \"path_prefix\": \"webhook-deliveries/\"}}" } }, "description": "Input type for storage destination configuration." }, "StorageConfigInput": { "type": "object", "properties": { "aws_s3_config": { "$ref": "#/components/schemas/AwsS3ConfigInput", "description": "AWS S3 storage configuration.\nExample: {\"bucket_name\": \"my-webhook-files\", \"region\": \"us-west-2\", \"role_arn\": \"arn:aws:iam::123456789012:role/WebhookDeliveryRole\", \"external_id\": \"ts-webhook-a1b2c3d4-7890\", \"path_prefix\": \"webhook-deliveries/\"}", "nullable": true }, "gcp_gcs_config": { "$ref": "#/components/schemas/GcpGcsConfigInput", "description": "GCP GCS storage configuration.\nExample: {\"bucket_name\": \"my-webhook-files\", \"service_account_email\": \"my-sa@my-project.iam.gserviceaccount.com\", \"path_prefix\": \"webhooks/\"}
Version: 26.7.0.cl or later", "nullable": true } }, "description": "Input type for storage configuration." }, "AwsS3ConfigInput": { "type": "object", "required": [ "bucket_name", "region", "role_arn" ], "properties": { "bucket_name": { "type": "string", "description": "Name of the S3 bucket where webhook payloads will be stored.\nExample: \"my-webhook-files\"" }, "region": { "type": "string", "description": "AWS region where the S3 bucket is located.\nExample: \"us-west-2\"" }, "role_arn": { "type": "string", "description": "ARN of the IAM role to assume for S3 access.\nExample: \"arn:aws:iam::123456789012:role/WebhookDeliveryRole\"" }, "external_id": { "type": "string", "description": "External ID for secure cross-account role assumption.\nExample: \"ts-webhook-a1b2c3d4-7890\"", "nullable": true }, "path_prefix": { "type": "string", "description": "Optional path prefix for organizing objects within the bucket.\nExample: \"webhook-deliveries/\"", "nullable": true } }, "description": "Input type for AWS S3 storage configuration." }, "GcpGcsConfigInput": { "type": "object", "required": [ "bucket_name", "service_account_email" ], "properties": { "bucket_name": { "type": "string", "description": "Name of the GCS bucket where webhook payloads will be stored.\nExample: \"my-webhook-files\"" }, "service_account_email": { "type": "string", "description": "Email of the GCP service account to impersonate for bucket access.\nThe platform's service account must be granted roles/iam.serviceAccountTokenCreator on this SA.\nExample: \"my-sa@my-project.iam.gserviceaccount.com\"" }, "path_prefix": { "type": "string", "description": "Optional path prefix for organizing objects within the bucket.\nExample: \"webhooks/\"", "nullable": true } }, "description": "Input type for GCP GCS storage configuration." }, "WebhookKeyValuePairInput": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "description": "Header name." }, "value": { "type": "string", "description": "Header value." } }, "description": "Key-value pair input for additional webhook headers." }, "WebhookDeleteResponse": { "type": "object", "required": [ "deleted_count", "failed_count", "deleted_webhooks", "failed_webhooks" ], "properties": { "deleted_count": { "type": "integer", "format": "int32", "description": "Number of webhooks successfully deleted." }, "failed_count": { "type": "integer", "format": "int32", "description": "Number of webhooks that failed to delete." }, "deleted_webhooks": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookResponse" }, "description": "List of successfully deleted webhooks." }, "failed_webhooks": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDeleteFailure" }, "description": "List of webhooks that failed to delete with error details." } } }, "WebhookDeleteFailure": { "type": "object", "required": [ "id", "name", "error" ], "properties": { "id": { "type": "string", "description": "Unique identifier of the webhook that failed to delete." }, "name": { "type": "string", "description": "Name of the webhook that failed to delete." }, "error": { "type": "string", "description": "Error message describing why the deletion failed." } } }, "CollectionMetadataInput": { "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "COLLECTION" ], "description": "Type of metadata object." }, "identifiers": { "type": "array", "items": { "type": "string" }, "description": "List of unique IDs or names of metadata objects." } }, "description": "Input type for metadata to be added to a collection." }, "CollectionDeleteResponse": { "type": "object", "properties": { "metadata_deleted": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionDeleteTypeIdentifiers" }, "description": "List of metadata objects that were successfully deleted.", "nullable": true }, "metadata_skipped": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionDeleteTypeIdentifiers" }, "description": "List of metadata objects that were skipped during deletion.\nObjects may be skipped due to lack of permissions, dependencies, or other constraints.", "nullable": true } }, "description": "Response object for delete collection operation." }, "CollectionDeleteTypeIdentifiers": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the metadata object (e.g., Collection, Worksheet, Table).", "nullable": true }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/GenericInfo" }, "description": "List of metadata identifiers belonging to the given type.", "nullable": true } }, "description": "Group of metadata objects identified by type." }, "StyleResetOptionsInput": { "type": "object", "properties": { "style": { "type": "array", "items": { "type": "string", "enum": [ "CHART_COLOR_PALETTE", "EMBEDDED_FOOTER_TEXT", "NAV_PANEL_COLOR", "DEFAULT_LOGO", "WIDE_LOGO" ] }, "description": "Style fields to reset. Supported values: CHART_COLOR_PALETTE,\nEMBEDDED_FOOTER_TEXT, NAV_PANEL_COLOR, DEFAULT_LOGO, WIDE_LOGO.", "nullable": true }, "visualization_areas": { "type": "array", "items": { "type": "string", "enum": [ "CHART_X_AXIS_LABELS", "CHART_X_AXIS_TITLE", "CHART_Y_AXIS_LABELS", "CHART_Y_AXIS_TITLE", "CHART_TOOLTIP", "CHART_SCATTER_DATA_LABELS", "CHART_DONUT_DATA_LABELS", "CHART_LINE_DATA_LABELS", "CHART_COLUMN_DATA_LABELS", "CHART_BAR_DATA_LABELS", "CHART_AREA_DATA_LABELS", "TABLE_VALUE_CELLS", "ADVANCED_CHART_LABELS" ] }, "description": "Visualization areas whose font assignments should revert to the system\ndefault font.", "nullable": true } }, "description": "Fields to revert to defaults when operation is RESET." }, "NavigationPanelInput": { "type": "object", "properties": { "theme": { "type": "string", "enum": [ "DARK", "TWO_TONE", "CUSTOM" ], "description": "Color mode for the navigation panel. DARK applies the default dark theme.\nTWO_TONE applies a dual-tone style. CUSTOM enables a user-defined base\ncolor; base_color is required when theme is CUSTOM.", "nullable": true }, "base_color": { "type": "string", "description": "Base color as a 6-digit hex string (e.g. \"#2359B6\"). Required when theme\nis CUSTOM.", "nullable": true } }, "description": "Navigation panel color configuration." }, "StyleColorPaletteInput": { "type": "object", "properties": { "colors": { "type": "array", "items": { "$ref": "#/components/schemas/StyleColorEntryInput" }, "description": "Ordered array of exactly 8 color entries defining the chart color palette.", "nullable": true }, "disable_color_rotation": { "type": "boolean", "description": "When true, disables automatic color rotation across chart data series.", "nullable": true } }, "description": "Chart color palette configuration." }, "StyleColorEntryInput": { "type": "object", "required": [ "primary" ], "properties": { "primary": { "type": "string", "description": "Primary color as a 6-digit hex string (e.g. \"#2359B6\"). Required." }, "secondary": { "type": "array", "items": { "type": "string" }, "description": "Array of exactly 4 secondary shade hex strings. If omitted, the server\nauto-generates 4 shades from the primary color. If provided, must contain\nexactly 4 valid 6-digit hex color strings.", "nullable": true } }, "description": "A single color entry in the chart color palette." }, "VisualizationFontsInput": { "type": "object", "properties": { "chart_visualization_fonts": { "type": "array", "items": { "$ref": "#/components/schemas/ChartFontAssignmentInput" }, "description": "Font assignments for chart visualization areas. Provide only the areas to\nupdate; omitted areas remain unchanged.", "nullable": true }, "table_visualization_fonts": { "type": "array", "items": { "$ref": "#/components/schemas/TableFontAssignmentInput" }, "description": "Font assignments for table visualization areas. Provide only the areas to\nupdate; omitted areas remain unchanged.", "nullable": true }, "advanced_chart_visualization_fonts": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancedChartFontAssignmentInput" }, "description": "Font assignments for advanced chart visualization areas. Provide only the\nareas to update; omitted areas remain unchanged.
Version: 26.7.0.cl or later", "nullable": true } }, "description": "Font assignments grouped by visualization type." }, "ChartFontAssignmentInput": { "type": "object", "required": [ "visualization_area", "font_identifier" ], "properties": { "visualization_area": { "type": "string", "enum": [ "CHART_X_AXIS_LABELS", "CHART_X_AXIS_TITLE", "CHART_Y_AXIS_LABELS", "CHART_Y_AXIS_TITLE", "CHART_TOOLTIP", "CHART_SCATTER_DATA_LABELS", "CHART_DONUT_DATA_LABELS", "CHART_LINE_DATA_LABELS", "CHART_COLUMN_DATA_LABELS", "CHART_BAR_DATA_LABELS", "CHART_AREA_DATA_LABELS" ], "description": "Chart visualization area to assign the font to." }, "font_identifier": { "type": "string", "description": "UUID or name of the font to assign to this area." } }, "description": "Font assignment for a single chart visualization area." }, "TableFontAssignmentInput": { "type": "object", "required": [ "visualization_area", "font_identifier" ], "properties": { "visualization_area": { "type": "string", "enum": [ "TABLE_VALUE_CELLS" ], "description": "Table visualization area to assign the font to." }, "font_identifier": { "type": "string", "description": "UUID or name of the font to assign to this area." } }, "description": "Font assignment for a single table visualization area." }, "AdvancedChartFontAssignmentInput": { "type": "object", "required": [ "visualization_area", "font_identifier" ], "properties": { "visualization_area": { "type": "string", "enum": [ "ADVANCED_CHART_LABELS" ], "description": "Advanced chart visualization area to assign the font to.
Version: 26.7.0.cl or later" }, "font_identifier": { "type": "string", "description": "UUID or name of the font to assign to this area.
Version: 26.7.0.cl or later" } }, "description": "Font assignment for a single advanced chart visualization area." }, "StyleFontUploadData": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "Unique UUID identifier of the uploaded font." }, "name": { "type": "string", "description": "Display name of the uploaded font." } }, "description": "Font data returned after a successful upload." }, "StyleFontDeleteData": { "type": "object", "properties": { "affected_assignments": { "type": "array", "items": { "$ref": "#/components/schemas/StyleFontDeleteAffectedAssignment" }, "description": "Visualization areas that used the deleted font(s) and were automatically\nreset to the system default font. Empty if no areas were affected.", "nullable": true } }, "description": "Result data for font deletion." }, "StyleFontDeleteAffectedAssignment": { "type": "object", "properties": { "org": { "$ref": "#/components/schemas/StyleOrgInfo", "description": "Org context for this assignment. Present only when scope is ORG.", "nullable": true }, "visualization_areas": { "type": "array", "items": { "type": "string", "enum": [ "CHART_X_AXIS_LABELS", "CHART_X_AXIS_TITLE", "CHART_Y_AXIS_LABELS", "CHART_Y_AXIS_TITLE", "CHART_TOOLTIP", "CHART_SCATTER_DATA_LABELS", "CHART_DONUT_DATA_LABELS", "CHART_LINE_DATA_LABELS", "CHART_COLUMN_DATA_LABELS", "CHART_BAR_DATA_LABELS", "CHART_AREA_DATA_LABELS", "TABLE_VALUE_CELLS", "ADVANCED_CHART_LABELS" ] }, "description": "Visualization areas that used the deleted font and were automatically reset\nto the system default font.", "nullable": true } }, "description": "A visualization area assignment affected by a font deletion." }, "SemanticIntegrationResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the semantic integration.", "nullable": true }, "name": { "type": "string", "description": "Name of the semantic integration.", "nullable": true }, "model_id": { "type": "string", "description": "Model GUID generated for this integration.", "nullable": true }, "model_name": { "type": "string", "description": "Model name generated for this integration.", "nullable": true }, "semantic_report": { "$ref": "#/components/schemas/SemanticIntegrationReport", "description": "Per-formula import report.", "nullable": true } }, "description": "Response object for a semantic integration." }, "SemanticIntegrationReport": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/SemanticIntegrationReportSummary", "description": "Summary of formula import counts.", "nullable": true }, "formulas": { "type": "array", "items": { "$ref": "#/components/schemas/SemanticIntegrationFormulaReport" }, "description": "Formula import details.", "nullable": true } }, "description": "Per-formula import report for a semantic integration." }, "SemanticIntegrationReportSummary": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32", "description": "Total number of formulas.", "nullable": true }, "imported": { "type": "integer", "format": "int32", "description": "Number of successfully imported formulas.", "nullable": true }, "failed": { "type": "integer", "format": "int32", "description": "Number of failed formula imports.", "nullable": true }, "skipped": { "type": "integer", "format": "int32", "description": "Number of skipped formulas.", "nullable": true } }, "description": "Formula import counts summary." }, "SemanticIntegrationFormulaReport": { "type": "object", "properties": { "id": { "type": "string", "description": "Formula ID in the model.", "nullable": true }, "name": { "type": "string", "description": "Formula name.", "nullable": true }, "description": { "type": "string", "description": "Formula description.", "nullable": true }, "source_expression": { "type": "string", "description": "CDW source expression.", "nullable": true }, "translated_formula": { "type": "string", "description": "ThoughtSpot formula equivalent.", "nullable": true }, "import_status": { "type": "string", "enum": [ "IMPORTED", "FAILED", "SKIPPED" ], "description": "Import status.", "nullable": true }, "change_status": { "type": "string", "enum": [ "NEW", "UPDATED", "UNCHANGED" ], "description": "Change status since last import. Null on initial create.", "nullable": true } }, "description": "Import details for a single formula." }, "FeatureAssignmentResponse": { "type": "object", "required": [ "feature_id", "assigned_orgs" ], "properties": { "feature_id": { "type": "string", "description": "Underlying unique feature ID. The dotted-path format (for example,\n`orion.embraceConfig.doIndexing`) is internal and subject to change without\nnotice; use `feature_name` as the stable display identifier where possible." }, "feature_name": { "type": "string", "description": "User-friendly feature name. Present when the feature declares one.", "nullable": true }, "assigned_orgs": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureOrgInfo" }, "description": "Updated set of Orgs assigned to the feature." } }, "description": "Response returned when a feature's Org assignments are updated." }, "FeatureValueResponse": { "type": "object", "required": [ "feature_id", "feature_value" ], "properties": { "feature_id": { "type": "string", "description": "Underlying unique feature ID. The dotted-path format (for example,\n`orion.embraceConfig.doIndexing`) is internal and subject to change without\nnotice; use `feature_name` as the stable display identifier where possible." }, "feature_name": { "type": "string", "description": "User-friendly feature name. Present when the feature declares one.", "nullable": true }, "feature_value": { "type": "string", "description": "The value that was written." } }, "description": "Response returned when a feature's value is set." }, "Runtime_Filter": { "type": "object", "properties": { "runtime_filter": { "type": "object", "description": "Runtime filter parameter type in JWT." } }, "description": "List of runtime parameters need to set during the session." }, "Runtime_Sort": { "type": "object", "properties": { "runtime_sort": { "type": "object", "description": "Runtime sort parameter type in JWT." } }, "description": "List of runtime parameters need to set during the session." }, "Runtime_Param_Override": { "type": "object", "properties": { "runtime_param_override": { "type": "object", "description": "Runtime param override type in JWT." } }, "description": "List of runtime parameters need to set during the session." }, "CreateAgentConversationRequest": { "type": "object", "properties": { "metadata_context": { "description": "Context for the conversation. Required unless `analyst_identifier` is\nprovided; do not pass both.", "allOf": [ { "$ref": "#/components/schemas/ContextPayloadV2Input" } ] }, "conversation_settings": { "description": "Conversation settings.", "allOf": [ { "$ref": "#/components/schemas/ConversationSettingsInput" } ] }, "analyst_identifier": { "description": "Unique identifier of the Spotter Analyst to start the conversation from.\nWhen provided, the conversation uses the analyst's configuration (data\nsources, agent instructions, and connectors), and `metadata_context`\nmust be omitted.
Version: 26.10.0.cl or later", "type": "string" } }, "required": [ "conversation_settings" ] }, "CreateAnalystRequest": { "type": "object", "properties": { "name": { "description": "Display name of the analyst.", "type": "string" }, "description": { "description": "Description of the analyst. Maximum 200 characters.", "type": "string" }, "instructions": { "description": "Natural-language instructions that guide the agent's behavior for this\nanalyst.", "type": "string" }, "sources": { "description": "Data sources the analyst can query. At least one is required, and the\ncaller must have view access to every referenced source.", "type": "array", "items": { "$ref": "#/components/schemas/AnalystSourceInput" } }, "mcp_connector_identifiers": { "description": "Identifiers of MCP connectors to link to this analyst.", "default": [], "type": "array", "items": { "type": "string" } }, "starter_prompts": { "description": "Plain-text starter prompts shown on the analyst landing page. Maximum 4,\neach between 10 and 250 characters; display order follows list position.", "default": [], "type": "array", "items": { "type": "string" } } }, "required": [ "name", "description", "sources" ] }, "CreateConversationRequest": { "type": "object", "properties": { "metadata_identifier": { "description": "ID of the metadata object, such as a Worksheet or Model, to use as a data source for the conversation.", "type": "string" }, "tokens": { "description": "Token string to set the context for the conversation. For example,`[sales],[item type],[state]`.", "type": "string" } }, "required": [ "metadata_identifier" ] }, "ExportMemoryRequest": { "type": "object", "properties": { "sources": { "description": "List of typed scope groups selecting which data-models to export\nmemory for. Supply `DATA_MODEL` group to scope the\nexport to specific data-models.", "type": "array", "items": { "$ref": "#/components/schemas/MemorySources" } } }, "required": [ "sources" ] }, "GetDataSourceSuggestionsRequest": { "type": "object", "properties": { "query": { "description": "User query used to suggest data sources. Must be a non-empty string.", "type": "string" } }, "required": [ "query" ] }, "GetNLInstructionsRequest": { "type": "object", "properties": { "data_source_identifier": { "description": "Unique ID or name of the data-model for which to retrieve NL instructions.", "type": "string" } }, "required": [ "data_source_identifier" ] }, "GetRelevantQuestionsRequest": { "type": "object", "properties": { "metadata_context": { "description": "metadata for the query to enable generation of relevant sub-questions; at least one context identifier is required.", "allOf": [ { "$ref": "#/components/schemas/MetadataContext" } ] }, "limit_relevant_questions": { "description": "Maximum number of relevant questions that is allowed in the response, default = 5.", "type": "integer", "format": "int32" }, "bypass_cache": { "description": "If true, results are not returned from cache & calculated every time.", "type": "boolean", "nullable": true }, "query": { "description": "A user query that requires breaking down into smaller, more manageable analytical questions to facilitate better understanding and analysis. Must be a non-empty string.", "type": "string" }, "ai_context": { "description": "Additional context to guide the response.", "allOf": [ { "$ref": "#/components/schemas/AIContext" } ] } }, "required": [ "metadata_context", "query" ] }, "ImportMemoryRequest": { "type": "object", "properties": { "content": { "description": "The full serialized memory payload to import (YAML) —\ntypically a previous `exportMemory` response's `content`, edited\nlocally and re-submitted.", "type": "string" }, "dry_run": { "description": "Required. When `true`, validate the payload and return preview\ncounts and row failures without writing anything. Pass `false` to\napply the import. The caller must choose explicitly so\na real import is never triggered by omission.", "type": "boolean" } }, "required": [ "content", "dry_run" ] }, "QueryGetDecomposedQueryRequest": { "type": "object", "properties": { "answerIds": { "description": "List of answer unique identifiers (GUIDs) whose data will be used to guide the response.", "type": "array", "items": { "type": "string" } }, "content": { "description": "User provided content like text data, csv data as a string message to provide context & potentially improve the quality of the response.", "type": "array", "items": { "type": "string" } }, "conversationId": { "description": "Unique identifier to denote current conversation.", "type": "string" }, "liveboardIds": { "description": "List of liveboard unique identifiers (GUIDs) whose data will be used to guide the response.", "type": "array", "items": { "type": "string" } }, "maxDecomposedQueries": { "description": "Maximum number of decomposed queries that is allowed in the response, default = 5.", "type": "integer", "format": "int32" }, "nlsRequest": { "description": "NLSRequest object containing user query & instructions.", "allOf": [ { "$ref": "#/components/schemas/Input_eureka_NLSRequest" } ] }, "worksheetIds": { "description": "List of worksheetIds to provide context for decomposing user query into analytical queries that can be run on them.", "type": "array", "items": { "type": "string" } } } }, "SearchAnalystsRequest": { "type": "object", "properties": { "analyst_identifier": { "description": "Unique identifier of an analyst. When provided, fetch mode: the response\ncontains exactly that analyst and the other filters are ignored.", "type": "string" }, "record_size": { "description": "List mode: number of records per page. Default 50, maximum 500.", "default": 50, "type": "integer", "format": "int32" }, "record_offset": { "description": "List mode: zero-based index of the first record to return.\nMaximum 10000.", "default": 0, "type": "integer", "format": "int32" }, "query": { "description": "List mode: case-insensitive substring match on the analyst name.", "type": "string" }, "type": { "description": "List mode: ownership filter — ALL (created by or shared with me),\nCREATED_BY_ME, or SHARED_TO_ME.", "default": "ALL", "type": "string", "enum": [ "ALL", "CREATED_BY_ME", "SHARED_TO_ME" ] } } }, "SendAgentConversationMessageRequest": { "type": "object", "properties": { "messages": { "description": "messages to be sent to the agent", "type": "array", "items": { "type": "string" } } }, "required": [ "messages" ] }, "SendAgentConversationMessageStreamingRequest": { "type": "object", "properties": { "messages": { "description": "messages to be sent to the agent", "type": "array", "items": { "type": "string" } } }, "required": [ "messages" ] }, "SendAgentMessageRequest": { "type": "object", "properties": { "messages": { "description": "messages to be sent to the agent", "type": "array", "items": { "type": "string" } } }, "required": [ "messages" ] }, "SendAgentMessageStreamingRequest": { "type": "object", "properties": { "conversation_identifier": { "description": "Unique identifier for the conversation (used to track context)", "type": "string" }, "messages": { "description": "messages to be sent to the agent", "type": "array", "items": { "type": "string" } } }, "required": [ "conversation_identifier", "messages" ] }, "SendMessageRequest": { "type": "object", "properties": { "metadata_identifier": { "description": "ID of the metadata object, such as a Worksheet or Model, to use as a data source for the conversation.", "type": "string" }, "message": { "description": "A message string with the follow-up question to continue the conversation.", "type": "string" } }, "required": [ "metadata_identifier", "message" ] }, "SetAgentInstructionsRequest": { "type": "object", "properties": { "instructions": { "description": "The admin instructions text to set for the agent.", "type": "string" } }, "required": [ "instructions" ] }, "SetNLInstructionsRequest": { "type": "object", "properties": { "data_source_identifier": { "description": "Unique ID or name of the data-model for which to set NL instructions.", "type": "string" }, "nl_instructions_info": { "description": "List of NL instructions to set for the data-model.", "type": "array", "items": { "$ref": "#/components/schemas/NLInstructionsInfoInput" } } }, "required": [ "data_source_identifier", "nl_instructions_info" ] }, "ShareAnalystRequest": { "type": "object", "properties": { "permissions": { "description": "Access changes to apply, one entry per principal. `principal.type` is\nrequired for analyst sharing, and `content_share_mode` does not apply\nto analysts and is ignored.", "type": "array", "items": { "$ref": "#/components/schemas/SharePermissionsInput" } } }, "required": [ "permissions" ] }, "ShareConversationRequest": { "type": "object", "properties": { "refresh_shared_content": { "description": "When `true`, always regenerates the shared view from the latest conversation\nstate, even if one already exists. When `false` (default), reuses the\nexisting shared view.", "default": false, "type": "boolean", "nullable": true }, "grant": { "description": "Principals to grant read-only access to the conversation.", "default": [], "type": "array", "items": { "$ref": "#/components/schemas/PrincipalRefInput" } }, "revoke": { "description": "Principals to revoke access from the conversation.", "default": [], "type": "array", "items": { "$ref": "#/components/schemas/PrincipalRefInput" } }, "notify_on_share": { "description": "
Version: 26.10.0.cl or later
\n\nWhen `true` (default), newly granted principals are notified of the share. When `false`, access is granted without sending a notification. Has no effect on principals passed in `revoke`. Does not re-notify a principal who already had access.", "default": true, "type": "boolean", "nullable": true } }, "required": [ "grant", "revoke" ] }, "SingleAnswerRequest": { "type": "object", "properties": { "query": { "description": "A natural language query string to generate the Answer.", "type": "string" }, "metadata_identifier": { "description": "ID of the metadata object, such as a Worksheet or Model, to use as a data source for the query.", "type": "string" } }, "required": [ "query", "metadata_identifier" ] }, "UpdateAnalystRequest": { "type": "object", "properties": { "name": { "description": "Display name of the analyst.", "type": "string" }, "description": { "description": "Description of the analyst. Maximum 200 characters.", "type": "string" }, "instructions": { "description": "Natural-language instructions that guide the agent's behavior for this\nanalyst. Omitting this field clears any existing instructions.", "type": "string" }, "sources": { "description": "Data sources the analyst can query. At least one is required, and the\ncaller must have view access to every referenced source. Replaces the\nexisting list in full.", "type": "array", "items": { "$ref": "#/components/schemas/AnalystSourceInput" } }, "mcp_connector_identifiers": { "description": "Identifiers of MCP connectors linked to this analyst. Replaces the\nexisting list in full; omit or pass an empty array to clear.", "default": [], "type": "array", "items": { "type": "string" } }, "starter_prompts": { "description": "Plain-text starter prompts (max 4, each between 10 and 250 characters;\ndisplay order follows list position). Replaces the existing list in\nfull; omit or pass an empty array to clear.", "default": [], "type": "array", "items": { "type": "string" } } }, "required": [ "name", "description", "sources" ] }, "UpdateConversationRequest": { "type": "object", "properties": { "title": { "description": "New display title for the conversation. Omit to leave the title\nunchanged. An empty or whitespace-only value is replaced with a default\ntitle rather than rejected.", "type": "string" }, "is_pinned": { "description": "Pinned state of the conversation for the current user. Pinning marks a\nconversation for quick access: pinned conversations are surfaced first in\n`getConversationList`. Set to `true` to pin the conversation, `false` to\nunpin it, or omit to leave the pinned state unchanged. Applying the state\nthe conversation is already in is a no-op success.
Version: 26.10.0.cl or later", "type": "boolean", "nullable": true } } }, "ConfigureAuthSettingsRequest": { "type": "object", "properties": { "auth_type": { "description": "Type of authentication mechanism to configure. Currently supports TRUSTED_AUTH.", "type": "string", "enum": [ "TRUSTED_AUTH" ] }, "cluster_preferences": { "description": "Cluster-level authentication preferences. Omit to leave the existing cluster setting unchanged.", "allOf": [ { "$ref": "#/components/schemas/AuthClusterPreferencesInput" } ] }, "org_preferences": { "description": "Org-level authentication preferences. Each entry identifies an org and the desired status. Omit to leave existing org settings unchanged.", "type": "array", "items": { "$ref": "#/components/schemas/AuthOrgPreferenceInput" } } }, "required": [ "auth_type" ] }, "GetCustomAccessTokenRequest": { "type": "object", "properties": { "username": { "description": "Username of the ThoughtSpot user. The username is stored in the `name` attribute of the user object.", "type": "string" }, "password": { "description": "Password of the user account", "default": "", "type": "string" }, "secret_key": { "description": "The secret key string provided by the ThoughtSpot application server. ThoughtSpot generates a secret key when Trusted authentication is enabled.", "default": "", "type": "string" }, "validity_time_in_sec": { "description": "Token validity duration in seconds", "default": 300, "type": "integer", "format": "int32" }, "org_identifier": { "description": "ID or name of the Org context to log in to. If the Org ID or name is not specified but a secret key is provided, the user will be logged into the Org associated with the secret key. If neither the Org ID/name nor the secret key is provided, the user will be logged into the Org context from their previous login session.", "type": "string" }, "scope": { "description": "The set of Orgs this token is authorized to operate in, recorded at issuance. Only applicable to a Tenant Administrator. Only SPECIFIC_ORGS is supported for a custom (ABAC) token -- it authorizes the token for the Orgs listed in org_identifiers. Each subsequent request selects one Org from this set using the `X-Org-Selector` header.
Beta Version: 26.10.0.cl or later", "allOf": [ { "$ref": "#/components/schemas/TokenScopeInput" } ] }, "persist_option": { "description": "Indicates whether the specified attributes should be persisted or not. RESET and NONE are not applicable if you are setting variable_values.", "type": "string", "enum": [ "REPLACE", "APPEND", "NONE", "RESET" ] }, "filter_rules": { "description": "Filter rules.", "type": "array", "items": { "$ref": "#/components/schemas/FilterRules" } }, "parameter_values": { "description": "Allows developers to assign parameter values for existing parameters to a user at login. Note: Using parameter values for row level security use cases will ultimately be deprecated. Developers can still pass data security values via the Custom Access token via the variable_values field and create RLS rules based on custom variables. Please refer to the [ABAC via RLS documentation](https://developers.thoughtspot.com/docs/abac-user-parameters) for more details.", "type": "array", "items": { "$ref": "#/components/schemas/ParameterValues" } }, "variable_values": { "description": "List of variable values where `name` references an existing formula variable and `values` is any value from the corresponding column.
Version: 10.14.0.cl or later", "type": "array", "items": { "$ref": "#/components/schemas/VariableValues" } }, "objects": { "description": "Objects on which the parameter and variable values should be applied to", "type": "array", "items": { "$ref": "#/components/schemas/TokenAccessScopeObject" } }, "email": { "description": "(just-in-time (JIT) provisioning)Email address of the user. Specify this attribute when creating a new user.", "type": "string" }, "display_name": { "description": "(just-in-time (JIT) provisioning) Indicates display name of the user. Specify this attribute when creating a new user.", "type": "string" }, "groups": { "description": "(just-in-time (JIT) provisioning) ID or name of the groups to which the newly created user belongs. Specify this attribute when creating a new user.", "type": "array", "items": { "$ref": "#/components/schemas/Group_Object" } }, "auto_create": { "description": " Creates a new user if the specified username does not exist in ThoughtSpot. To provision a user just-in-time (JIT), set this attribute to true.\n \n\nNote: For JIT provisioning of a user, the secret_key is required. New formula variables won't be created.
Version: 10.5.0.cl or later", "default": true, "type": "boolean", "nullable": true } }, "required": [ "username", "persist_option" ] }, "GetFullAccessTokenRequest": { "type": "object", "properties": { "username": { "description": "Username of the ThoughtSpot user. The username is stored in the `name` attribute of the user object.", "type": "string" }, "password": { "description": "Password of the user account", "default": "", "type": "string" }, "secret_key": { "description": "The secret key string provided by the ThoughtSpot application server. ThoughtSpot generates a secret key when Trusted authentication is enabled.", "default": "", "type": "string" }, "validity_time_in_sec": { "description": "Token validity duration in seconds", "default": 300, "type": "integer", "format": "int32" }, "org_id": { "description": "ID of the Org context to log in to. If the Org ID is not specified and secret key is provided then user will be logged into the org corresponding to the secret key, and if secret key is not provided then user will be logged in to the Org context of their previous login session.", "type": "integer", "format": "int32" }, "scope": { "description": "The set of Orgs this token is authorized to operate in, recorded at issuance. Only applicable to a Tenant Administrator. Each subsequent request selects one Org from this set using the `X-Org-Selector` header.
Beta Version: 26.10.0.cl or later", "allOf": [ { "$ref": "#/components/schemas/TokenScopeInput" } ] }, "email": { "description": "Email address of the user. Specify this attribute when creating a new user (just-in-time (JIT) provisioning).", "type": "string" }, "display_name": { "description": "Indicates display name of the user. Use this parameter to provision a user just-in-time (JIT).", "type": "string" }, "auto_create": { "description": " Creates a new user if the specified username does not already exist in ThoughtSpot. To provision a user just-in-time (JIT), set this attribute to true.\n \n\nNote: For JIT provisioning of a user, the secret_key is required. ", "default": false, "type": "boolean", "nullable": true }, "group_identifiers": { "description": "ID or name of the groups to which the newly created user belongs. Use this parameter to provision a user just-in-time (JIT).", "type": "array", "items": { "type": "string" } }, "user_parameters": { "description": "
Version: 9.10.5.cl or laterDeprecated: 10.4.0.cl and later
\n\nDefine attributes such as Runtime filters and Runtime parameters to send security entitlements to a user session. For more information, see [Documentation](https://developers.thoughtspot.com/docs/abac-user-parameters).", "allOf": [ { "$ref": "#/components/schemas/User_Parameter_Options" } ] } }, "required": [ "username" ] }, "GetObjectAccessTokenRequest": { "type": "object", "properties": { "username": { "description": "Username of the ThoughtSpot user. The username is stored in the `name` attribute of the user object.", "type": "string" }, "object_id": { "description": "GUID of the ThoughtSpot metadata object that the user can access. The bearer will only have access to the object specified in the API request.", "type": "string" }, "password": { "description": "Password of the user account", "default": "", "type": "string" }, "secret_key": { "description": "The secret key string provided by the ThoughtSpot application server. ThoughtSpot generates a secret key when Trusted authentication is enabled.", "default": "", "type": "string" }, "validity_time_in_sec": { "description": "Token validity duration in seconds", "default": 300, "type": "integer", "format": "int32" }, "org_id": { "description": "ID of the Org context to log in to. If the Org ID is not specified and secret key is provided then user will be logged into the org corresponding to the secret key, and if secret key is not provided then user will be logged in to the Org context of their previous login session.", "type": "integer", "format": "int32" }, "scope": { "description": "The set of Orgs this token is authorized to operate in, recorded at issuance. Only applicable to a Tenant Administrator. Each subsequent request selects one Org from this set using the `X-Org-Selector` header.
Beta Version: 26.10.0.cl or later", "allOf": [ { "$ref": "#/components/schemas/TokenScopeInput" } ] }, "email": { "description": "Email address of the user. Specify this attribute when creating a new user (just-in-time (JIT) provisioning).", "type": "string" }, "display_name": { "description": "Display name of the user. Specify this attribute when creating a new user (just-in-time (JIT) provisioning).", "type": "string" }, "auto_create": { "description": " Creates a new user if the specified username does not exist in ThoughtSpot. To provision a user just-in-time (JIT), set this attribute to true.\n \n\nNote: For JIT provisioning of a user, the secret_key is required. ", "default": false, "type": "boolean", "nullable": true }, "group_identifiers": { "description": "Unique ID or name of the groups to which you want to assign the new user. You can specify this attribute to dynamically assign privileges during just-in-time (JIT) provisioning.", "type": "array", "items": { "type": "string" } }, "user_parameters": { "description": "
Version: 9.10.5.cl or laterDeprecated: 10.4.0.cl and later
\n\nDefine attributes such as Runtime filters and Runtime parameters to send security entitlements to a user session. For more information, see [Documentation](https://developers.thoughtspot.com/docs/abac-user-parameters).", "allOf": [ { "$ref": "#/components/schemas/User_Parameter_Options" } ] } }, "required": [ "username" ] }, "LoginRequest": { "type": "object", "properties": { "username": { "description": "Username of the ThoughtSpot user", "type": "string" }, "password": { "description": "Password of the user account", "type": "string" }, "org_identifier": { "description": "ID of the Org context to log in to. If Org ID is not specified, the user will be logged in to the Org context of their previous login session.", "type": "string" }, "remember_me": { "description": "A flag to remember the user session. When set to true, a session cookie is created and used in subsequent API requests.", "default": false, "type": "boolean", "nullable": true } } }, "RevokeTokenRequest": { "type": "object", "properties": { "user_identifier": { "type": "string" }, "token": { "type": "string" } } }, "SearchAuthSettingsRequest": { "type": "object", "properties": { "auth_type": { "description": "Type of authentication mechanism to retrieve settings for. Currently supports TRUSTED_AUTH.", "type": "string", "enum": [ "TRUSTED_AUTH" ] }, "scope": { "description": "Scope of auth settings to retrieve. When absent, both cluster and org settings are returned (subject to caller privileges). Set to CLUSTER to retrieve only cluster-level settings, or ORG to retrieve only org-level settings.", "type": "string", "enum": [ "CLUSTER", "ORG" ] } }, "required": [ "auth_type" ] }, "ValidateTokenRequest": { "type": "object", "properties": { "token": { "type": "string" } }, "required": [ "token" ] }, "CreateCollectionRequest": { "type": "object", "properties": { "name": { "description": "Name of the collection.", "type": "string" }, "description": { "description": "Description of the collection.", "type": "string" }, "metadata": { "description": "Metadata objects to add to the collection.", "type": "array", "items": { "$ref": "#/components/schemas/CollectionMetadataInput" } } }, "required": [ "name" ] }, "DeleteCollectionRequest": { "type": "object", "properties": { "collection_identifiers": { "description": "Unique GUIDs of collections to delete. Note: Collection names cannot be\nused as identifiers since duplicate names are allowed.", "type": "array", "items": { "type": "string" } }, "delete_children": { "description": "Flag to delete child objects of the collection that the user has access to.", "default": false, "type": "boolean", "nullable": true }, "dry_run": { "description": "Preview deletion without actually deleting. When set to true, returns\nwhat would be deleted without performing the actual deletion.", "default": false, "type": "boolean", "nullable": true } }, "required": [ "collection_identifiers" ] }, "SearchCollectionsRequest": { "type": "object", "properties": { "name_pattern": { "description": "A pattern to match case-insensitive name of the Collection object.\nUse '%' for wildcard match.", "type": "string" }, "record_offset": { "description": "The starting record number from where the records should be included.", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "The number of records that should be included.\n-1 implies no pagination.", "default": 10, "type": "integer", "format": "int32" }, "collection_identifiers": { "description": "Unique GUIDs of collections to search. Note: Collection names cannot be\nused as identifiers since duplicate names are allowed.", "type": "array", "items": { "type": "string" } }, "created_by_user_identifiers": { "description": "Filter collections by author. Provide unique IDs or names of users\nwho created the collections.", "type": "array", "items": { "type": "string" } }, "include_metadata": { "description": "Include collection metadata items in the response.", "default": false, "type": "boolean", "nullable": true }, "sort_options": { "description": "Sort options.", "allOf": [ { "$ref": "#/components/schemas/SortOptions" } ] } } }, "UpdateCollectionRequest": { "type": "object", "properties": { "name": { "description": "Name of the collection.", "type": "string" }, "description": { "description": "Description of the collection.", "type": "string" }, "metadata": { "description": "Metadata objects to add, remove, or replace in the collection.", "type": "array", "items": { "$ref": "#/components/schemas/CollectionMetadataInput" } }, "operation": { "description": "Type of update operation. Default operation type is REPLACE.", "default": "REPLACE", "type": "string", "enum": [ "ADD", "REMOVE", "REPLACE" ] } } }, "ConnectionConfigurationSearchRequest": { "type": "object", "properties": { "connection_identifier": { "description": "Unique ID or name of the connection.", "type": "string" }, "configuration_identifier": { "description": "Unique ID or name of the configuration.", "type": "string" }, "policy_type": { "description": "Type of policy.", "type": "string", "enum": [ "NO_POLICY", "PRINCIPALS", "PROCESSES" ] } }, "required": [ "connection_identifier" ] }, "CreateConnectionConfigurationRequest": { "type": "object", "properties": { "name": { "description": "Unique name for the configuration.", "type": "string" }, "description": { "description": "Description of the configuration.", "type": "string" }, "connection_identifier": { "description": "Unique ID or name of the connection.", "type": "string" }, "same_as_parent": { "description": "Specifies whether the connection configuration should inherit all properties and authentication\ntype from its parent connection. This attribute is only applicable to parameterized connections.\nWhen set to true, the configuration uses only the connection properties and authentication type\ninherited from the parent.
Version: 26.2.0.cl or later", "default": false, "type": "boolean", "nullable": true }, "policy_process_options": { "description": "This attribute is only applicable to parameterized connections. Ensure that the policy is\nset to Processes to allow the configuration to be used exclusively for system processes.
Version: 26.2.0.cl or later", "allOf": [ { "$ref": "#/components/schemas/PolicyProcessOptionsInput" } ] }, "authentication_type": { "description": "Type of authentication used for the connection.", "default": "SERVICE_ACCOUNT", "type": "string", "enum": [ "SERVICE_ACCOUNT", "KEY_PAIR", "PERSONAL_ACCESS_TOKEN", "OAUTH_WITH_SERVICE_PRINCIPAL", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_CLIENT_CREDENTIALS_WITH_X509" ] }, "configuration": { "description": "Configuration properties in JSON.", "type": "object" }, "policy_type": { "description": "Type of policy.", "default": "NO_POLICY", "type": "string", "enum": [ "NO_POLICY", "PRINCIPALS", "PROCESSES" ] }, "policy_principals": { "description": "Unique ID or name of the User and User Groups.", "type": "array", "items": { "type": "string" } }, "policy_processes": { "description": "Action that the query performed on the data warehouse, such as SAGE_INDEXING, ROW_COUNT_STATS, and SCHEDULED_LIVEBOARDS.", "type": "array", "items": { "type": "string", "enum": [ "SAGE_INDEXING", "ROW_COUNT_STATS", "SCHEDULED_LIVEBOARDS" ] } } }, "required": [ "name", "connection_identifier", "configuration" ] }, "DeleteConnectionConfigurationRequest": { "type": "object", "properties": { "configuration_identifier": { "description": "Unique ID or name of the configuration.", "type": "string" }, "connection_identifier": { "description": "Unique ID or name of the connection.", "type": "string" } }, "required": [ "configuration_identifier", "connection_identifier" ] }, "UpdateConnectionConfigurationRequest": { "type": "object", "properties": { "connection_identifier": { "description": "Unique ID or name of the connection.", "type": "string" }, "name": { "description": "Name of the configuration to update.", "type": "string" }, "description": { "description": "Description of the configuration.", "type": "string" }, "same_as_parent": { "description": "Specifies whether the connection configuration should inherit all properties and authentication\ntype from its parent connection. This attribute is only applicable to parameterized connections.\nWhen set to true, the configuration uses only the connection properties and authentication type\ninherited from the parent.
Version: 26.2.0.cl or later", "default": false, "type": "boolean", "nullable": true }, "policy_process_options": { "description": "This attribute is only applicable to parameterized connections. Ensure that the policy is\nset to Processes to allow the configuration to be used exclusively for system processes.
Version: 26.2.0.cl or later", "allOf": [ { "$ref": "#/components/schemas/PolicyProcessOptionsInput" } ] }, "authentication_type": { "description": "Type of authentication.", "type": "string", "enum": [ "SERVICE_ACCOUNT", "OAUTH", "OAUTH_WITH_SERVICE_PRINCIPAL", "EXTOAUTH", "KEY_PAIR", "EXTOAUTH_WITH_PKCE", "OAUTH_WITH_PKCE", "PERSONAL_ACCESS_TOKEN", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_CLIENT_CREDENTIALS_WITH_X509" ] }, "configuration": { "description": "Configuration properties in JSON.", "type": "object" }, "policy_type": { "description": "Type of policy.", "type": "string", "enum": [ "NO_POLICY", "PRINCIPALS", "PROCESSES" ] }, "policy_principals": { "description": "Unique ID or name of the User and User Groups.", "type": "array", "items": { "type": "string" } }, "policy_processes": { "description": "Action that the query performed on the data warehouse, such as SAGE_INDEXING, ROW_COUNT_STATS, and SCHEDULED_LIVEBOARDS.", "type": "array", "items": { "type": "string", "enum": [ "SAGE_INDEXING", "ROW_COUNT_STATS", "SCHEDULED_LIVEBOARDS" ] } }, "disable": { "description": "Indicates whether the configuration enable/disable.", "default": false, "type": "boolean", "nullable": true } }, "required": [ "connection_identifier" ] }, "CreateConnectionRequest": { "type": "object", "properties": { "name": { "description": "Unique name for the connection.", "type": "string" }, "description": { "description": "Description of the connection.", "type": "string" }, "data_warehouse_type": { "description": "Type of the data warehouse.", "type": "string", "enum": [ "SNOWFLAKE", "AMAZON_REDSHIFT", "GOOGLE_BIGQUERY", "AZURE_SYNAPSE", "TERADATA", "SAP_HANA", "STARBURST", "ORACLE_ADW", "DATABRICKS", "DENODO", "DREMIO", "TRINO", "PRESTO", "POSTGRES", "SQLSERVER", "MYSQL", "GENERIC_JDBC", "AMAZON_RDS_POSTGRESQL", "AMAZON_AURORA_POSTGRESQL", "AMAZON_RDS_MYSQL", "AMAZON_AURORA_MYSQL", "LOOKER", "AMAZON_ATHENA", "SINGLESTORE", "GCP_SQLSERVER", "GCP_ALLOYDB_POSTGRESQL", "GCP_POSTGRESQL", "GCP_MYSQL", "MODE", "GOOGLE_SHEETS", "FALCON", "FALCON_ONPREM", "CLICKHOUSE", "IOMETE" ] }, "data_warehouse_config": { "description": "Connection configuration attributes in JSON format. To create a connection with tables, include table attributes. See the documentation above for sample JSON.", "type": "object" }, "validate": { "description": "Validates the connection metadata if tables are included. If you are creating a connection without tables, specify `false`.", "default": true, "type": "boolean", "nullable": true } }, "required": [ "name", "data_warehouse_type", "data_warehouse_config" ] }, "DeleteConnectionRequest": { "type": "object", "properties": { "connection_identifier": { "description": "Unique ID or name of the connection.", "type": "string" } }, "required": [ "connection_identifier" ] }, "RevokeRefreshTokensRequest": { "type": "object", "properties": { "configuration_identifiers": { "description": "Unique ID or name of the configuration. When provided, the refresh tokens of the users associated with the connection configuration will be revoked.", "type": "array", "items": { "type": "string" } }, "user_identifiers": { "description": "Unique ID or name of the users. When provided, the refresh tokens of the specified users will be revoked. If the request includes the user ID or name of the connection author, their token will also be revoked.", "type": "array", "items": { "type": "string" } }, "org_identifiers": { "description": "Unique ID or name of the Org. When provided, the refresh tokens of all users associated with the published connection in the Org will be revoked. This parameter is valid only for published connections. Using it with unpublished connections will result in an error.", "type": "array", "items": { "type": "string" } } } }, "SearchConnectionRequest": { "type": "object", "properties": { "connections": { "description": "List of connections and name pattern", "type": "array", "items": { "$ref": "#/components/schemas/ConnectionInput" } }, "data_warehouse_types": { "description": "Array of types of data warehouse defined for the connection.", "type": "array", "items": { "type": "string", "enum": [ "SNOWFLAKE", "AMAZON_REDSHIFT", "GOOGLE_BIGQUERY", "AZURE_SYNAPSE", "TERADATA", "SAP_HANA", "STARBURST", "ORACLE_ADW", "DATABRICKS", "DENODO", "DREMIO", "TRINO", "PRESTO", "POSTGRES", "SQLSERVER", "MYSQL", "GENERIC_JDBC", "AMAZON_RDS_POSTGRESQL", "AMAZON_AURORA_POSTGRESQL", "AMAZON_RDS_MYSQL", "AMAZON_AURORA_MYSQL", "LOOKER", "AMAZON_ATHENA", "SINGLESTORE", "GCP_SQLSERVER", "GCP_ALLOYDB_POSTGRESQL", "GCP_POSTGRESQL", "GCP_MYSQL", "MODE", "GOOGLE_SHEETS", "FALCON", "FALCON_ONPREM", "CLICKHOUSE", "IOMETE" ] } }, "record_offset": { "description": "The starting record number from where the records should be included.", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "The number of records that should be included.", "default": 10, "type": "integer", "format": "int32" }, "tag_identifiers": { "description": "Unique ID or name of tags.", "type": "array", "items": { "type": "string" } }, "data_warehouse_object_type": { "description": "Data warehouse object type.", "type": "string", "enum": [ "DATABASE", "SCHEMA", "TABLE", "COLUMN" ] }, "sort_options": { "description": "Sort options.", "allOf": [ { "$ref": "#/components/schemas/SortOptionInput" } ] }, "include_details": { "description": "Indicates whether to include complete details of the connection objects.", "type": "boolean", "nullable": true }, "configuration": { "description": "Configuration values. If empty we are fetching configuration from datasource based on given connection id. If required you can provide config details to fetch specific details. Example input: {}, {\"warehouse\":\"SMALL_WH\",\"database\":\"DEVELOPMENT\"}. This is only applicable when data_warehouse_object_type is selected.", "type": "object" }, "authentication_type": { "description": "List of authentication types to fetch data_ware_house_objects from external Data warehouse. This is only applicable when data_warehouse_object_type is selected.", "default": "SERVICE_ACCOUNT", "type": "string", "enum": [ "SERVICE_ACCOUNT", "OAUTH", "IAM", "EXTOAUTH", "OAUTH_WITH_SERVICE_PRINCIPAL", "PERSONAL_ACCESS_TOKEN", "KEY_PAIR", "OAUTH_WITH_PKCE", "EXTOAUTH_WITH_PKCE", "OAUTH_WITH_PEZ", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_CLIENT_CREDENTIALS_WITH_X509" ] }, "show_resolved_parameters": { "description": "
Version: 10.9.0.cl or later
\n\nIndicates whether to show resolved parameterised values.", "default": false, "type": "boolean", "nullable": true } } }, "SyncMetadataRequest": { "type": "object", "properties": { "tables": { "description": "Array of tables to sync. Each element can be:\n- String: Table identifier (GUID or name) to sync\n all columns for that table.\n- Object: {tableId: [columnIds]} to sync specific\n columns.\nIf not provided, syncs all tables in the connection.", "type": "object" }, "sync_attributes": { "description": "List of sync_attributes to sync from CDW.\nThe default value is DESCRIPTION.", "default": [ "DESCRIPTION" ], "type": "array", "items": { "type": "string", "enum": [ "DESCRIPTION" ] } } } }, "UpdateConnectionRequest": { "type": "object", "properties": { "connection_identifier": { "description": "Unique ID or name of the connection.", "type": "string" }, "name": { "description": "Updated name of the connection.", "type": "string" }, "description": { "description": "Updated description of the connection.", "type": "string" }, "data_warehouse_config": { "description": "Configuration of the data warehouse in JSON.", "type": "object" }, "validate": { "description": "Indicates whether to validate the connection details.", "default": true, "type": "boolean", "nullable": true } }, "required": [ "connection_identifier" ] }, "UpdateConnectionStatusRequest": { "type": "object", "properties": { "status": { "description": "Status to set for the connection. Use ACTIVATED to enable the connection or DEACTIVATED to disable it.", "default": "ACTIVATED", "type": "string", "enum": [ "ACTIVATED", "DEACTIVATED" ] } } }, "UpdateConnectionV2Request": { "type": "object", "properties": { "name": { "description": "Updated name of the connection.", "type": "string" }, "description": { "description": "Updated description of the connection.", "type": "string" }, "data_warehouse_config": { "description": "Configuration of the data warehouse in JSON.", "type": "object" }, "validate": { "description": "Indicates whether to validate the connection details.", "default": true, "type": "boolean", "nullable": true } } }, "CreateCustomActionRequest": { "type": "object", "properties": { "name": { "description": "Name of the custom action. The custom action name must be unique.", "type": "string" }, "action_details": { "description": "Action details includes `Type` and Configuration data for Custom Actions, either Callback or URL is required.", "allOf": [ { "$ref": "#/components/schemas/Action_Details_Input_Create" } ] }, "associate_metadata": { "description": "Metadata objects to which the custom action needs to be associated.", "type": "array", "items": { "$ref": "#/components/schemas/Associate_Metadata_Input_Create" } }, "default_action_config": { "description": "Default Custom action configuration. This includes if the custom action is available on all visualizations. By default, a custom action is added to all visualizations and Answers.", "allOf": [ { "$ref": "#/components/schemas/Default_Action_Config_Input_Create" } ] }, "group_identifiers": { "description": "Unique ID or name of the groups that can view and access the custom action.", "type": "array", "items": { "type": "string" } } }, "required": [ "name", "action_details" ] }, "SearchCustomActionsRequest": { "type": "object", "properties": { "custom_action_identifier": { "description": "Name or ID of the custom action.", "type": "string" }, "name_pattern": { "description": "A pattern to match case-insensitive name of the custom-action object.", "type": "string" }, "default_action_config": { "description": "Default Custom action configuration. This includes if the custom action is available on all visualizations. By default, a custom action is added to all visualizations and Answers.", "allOf": [ { "$ref": "#/components/schemas/Default_Action_Config_Search_Input" } ] }, "include_group_associations": { "description": "When set to true, returns the associated groups for a custom action.", "default": false, "type": "boolean", "nullable": true }, "include_metadata_associations": { "description": "When set to true, returns the associated metadata for a custom action.", "default": false, "type": "boolean", "nullable": true }, "metadata": { "description": "Search with a given metadata identifier.", "type": "array", "items": { "$ref": "#/components/schemas/CustomActionMetadataTypeInput" } }, "type": { "description": "Filter the action objects based on type", "type": "string", "enum": [ "CALLBACK", "URL" ] } } }, "UpdateCustomActionRequest": { "type": "object", "properties": { "action_details": { "description": "Action details includes `Type` and Configuration for Custom Actions, either Callback or URL is required.", "allOf": [ { "$ref": "#/components/schemas/Action_Details_Input" } ] }, "associate_metadata": { "description": "Metadata objects to which the custom action needs to be associated.", "type": "array", "items": { "$ref": "#/components/schemas/Associate_Metadata_Input" } }, "default_action_config": { "description": "Default Custom action configuration. This includes if the custom action available on visualizations and Answers. By default, a custom action is added to all visualizations and Answers.", "allOf": [ { "$ref": "#/components/schemas/Default_Action_Config_Input" } ] }, "group_identifiers": { "description": "Unique ID or name of the groups that can view and access the custom action.", "type": "array", "items": { "type": "string" } }, "name": { "description": "Name of the custom action. The custom action name must be unique.", "type": "string" }, "operation": { "description": "Type of update operation. Default operation type is ADD", "default": "ADD", "type": "string", "enum": [ "ADD", "REMOVE" ] } } }, "CreateCalendarRequest": { "type": "object", "properties": { "name": { "description": "Name of the custom calendar.", "type": "string" }, "creation_method": { "description": "Type of create operation.", "type": "string", "enum": [ "FROM_INPUT_PARAMS", "FROM_EXISTING_TABLE" ] }, "table_reference": { "description": "Table reference containing connection identifier and table details in this format: `{\"connection_identifier\":\"conn1\", \"database_name\":\"db1\", \"schema_name\":\"sc1\", \"table_name\":\"tb1\"}`. The given table will be created if `creation_method` is set as `FROM_INPUT_PARAMS`.", "allOf": [ { "$ref": "#/components/schemas/ExternalTableInput" } ] }, "start_date": { "description": "Start date for the calendar in `MM/dd/yyyy` format. This parameter is mandatory if `creation_method` is set as `FROM_INPUT_PARAMS`.", "type": "string" }, "end_date": { "description": "End date for the calendar in `MM/dd/yyyy` format. This parameter is mandatory if `creation_method` is set as `FROM_INPUT_PARAMS`.", "type": "string" }, "calendar_type": { "description": "Type of the calendar.", "default": "MONTH_OFFSET", "type": "string", "enum": [ "MONTH_OFFSET", "FOUR_FOUR_FIVE", "FOUR_FIVE_FOUR", "FIVE_FOUR_FOUR" ] }, "month_offset": { "description": "Specify the month in which the fiscal or custom calendar year should start. For example, if you set `month_offset` to \"April\", the custom calendar will treat \"April\" as the first month of the year, and the related attributes such as quarters and start date will be based on this offset. The default value is `January`, which represents the standard calendar year (January to December).", "default": "January", "type": "string", "enum": [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ] }, "start_day_of_week": { "description": "Specify the starting day of the week.", "default": "Sunday", "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "quarter_name_prefix": { "description": "Prefix to add before the quarter.", "default": "", "type": "string" }, "year_name_prefix": { "description": "Prefix to add before the year.", "default": "", "type": "string" } }, "required": [ "name", "creation_method", "table_reference" ] }, "GenerateCSVRequest": { "type": "object", "properties": { "start_date": { "description": "Start date for the calendar in `MM/dd/yyyy` format.", "type": "string" }, "end_date": { "description": "End date for the calendar in `MM/dd/yyyy` format.", "type": "string" }, "calendar_type": { "description": "Type of the calendar.", "default": "MONTH_OFFSET", "type": "string", "enum": [ "MONTH_OFFSET", "FOUR_FOUR_FIVE", "FOUR_FIVE_FOUR", "FIVE_FOUR_FOUR" ] }, "month_offset": { "description": "Month offset to start calendar from `January`.", "default": "January", "type": "string", "enum": [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ] }, "start_day_of_week": { "description": "Specify the starting day of the week.", "default": "Sunday", "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "quarter_name_prefix": { "description": "Prefix to add before the quarter.", "type": "string" }, "year_name_prefix": { "description": "Prefix to add before the year.", "type": "string" } }, "required": [ "start_date", "end_date" ] }, "SearchCalendarsRequest": { "type": "object", "properties": { "connection_identifier": { "description": "Unique ID or name of the connection.", "type": "string" }, "name_pattern": { "description": "Pattern to match for calendar names (use '%' for wildcard match).", "type": "string" }, "record_offset": { "description": "The starting record number from where the records should be included.", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "The number of records that should be included.", "default": 10, "type": "integer", "format": "int32" }, "sort_options": { "description": "Sort options.", "allOf": [ { "$ref": "#/components/schemas/SortOption" } ] } } }, "UpdateCalendarRequest": { "type": "object", "properties": { "update_method": { "description": "Type of update operation.", "default": "FROM_INPUT_PARAMS", "type": "string", "enum": [ "FROM_INPUT_PARAMS", "FROM_EXISTING_TABLE" ] }, "table_reference": { "description": "Table reference containing connection identifier and table details in this format: `{\"connection_identifier\":\"conn1\", \"database_name\":\"db1\", \"schema_name\":\"sc1\", \"table_name\":\"tb1\"}`.", "allOf": [ { "$ref": "#/components/schemas/ExternalTableInput" } ] }, "start_date": { "description": "Start date for the calendar in `MM/dd/yyyy` format. This parameter is mandatory if `update_method` is set as `FROM_INPUT_PARAMS`.", "type": "string" }, "end_date": { "description": "End date for the calendar in `MM/dd/yyyy` format. This parameter is mandatory if `update_method` is set as `FROM_INPUT_PARAMS`.", "type": "string" }, "calendar_type": { "description": "Type of the calendar.", "default": "MONTH_OFFSET", "type": "string", "enum": [ "MONTH_OFFSET", "FOUR_FOUR_FIVE", "FOUR_FIVE_FOUR", "FIVE_FOUR_FOUR" ] }, "month_offset": { "description": "Specify the month in which the fiscal or custom calendar year should start. For example, if you set `month_offset` to \"April\", the custom calendar will treat \"April\" as the first month of the year, and the related attributes such as quarters and start date will be based on this offset. The default value is `January`, which represents the standard calendar year (January to December).", "default": "January", "type": "string", "enum": [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ] }, "start_day_of_week": { "description": "Specify the starting day of the week", "default": "Sunday", "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "quarter_name_prefix": { "description": "Prefix to add before the quarter.", "default": "", "type": "string" }, "year_name_prefix": { "description": "Prefix to add before the year.", "default": "", "type": "string" } }, "required": [ "table_reference" ] }, "FetchAnswerDataRequest": { "type": "object", "properties": { "metadata_identifier": { "description": "GUID or name of the Answer.", "type": "string" }, "data_format": { "description": "JSON output in compact or full format. The FULL option is available in 9.12.5.cl or later.", "default": "COMPACT", "type": "string", "enum": [ "FULL", "COMPACT" ] }, "record_offset": { "description": "The starting record number from where the records should be included.", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "The number of records to include in a batch.", "default": 10, "type": "integer", "format": "int32" }, "runtime_filter": { "description": "JSON object with representing filter condition to apply filters at runtime. For example, {\"col1\": \"item type\", \"op1\": \"EQ\", \"val1\": \"Bags\"} . You can add multiple keys by incrementing the number at the end, for example, col2, op2, val2, and col3, op3, val3. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_filters).", "type": "object" }, "runtime_sort": { "description": "JSON object representing columns to sort data at runtime. For example, {\"sortCol1\": \"sales\", \"asc1\": true} . You can add multiple keys by incrementing the number at the end, for example, sortCol1, asc2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_sort).", "type": "object" }, "runtime_param_override": { "description": "JSON object for setting values of parameters at runtime. For example, {\"param1\": \"Double List Param\", \"paramVal1\": 0.5}. You can add multiple keys by incrementing the number at the end, for example, param2, paramVal2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_parameters).", "type": "object" } }, "required": [ "metadata_identifier" ] }, "FetchLiveboardDataRequest": { "type": "object", "properties": { "metadata_identifier": { "description": "GUID or name of the Liveboard.", "type": "string" }, "visualization_identifiers": { "description": "GUIDs or names of the visualizations on the Liveboard.", "type": "array", "items": { "type": "string" } }, "transient_content": { "description": "Transient content of the Liveboard.", "type": "string" }, "data_format": { "description": "JSON output in compact or full format. The FULL option is available in 9.12.5.cl or later.", "default": "COMPACT", "type": "string", "enum": [ "FULL", "COMPACT" ] }, "record_offset": { "description": "The starting record number from where the records should be included.", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "The number of records to include in a batch.", "default": 10, "type": "integer", "format": "int32" }, "runtime_filter": { "description": "JSON object with representing filter condition to apply filters at runtime. For example, {\"col1\": \"item type\", \"op1\": \"EQ\", \"val1\": \"Bags\"} . You can add multiple keys by incrementing the number at the end, for example, col2, op2, val2, and col3, op3, val3. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_filters).", "type": "object" }, "runtime_sort": { "description": "JSON object representing columns to sort data at runtime. For example, {\"sortCol1\": \"sales\", \"asc1\": true} . You can add multiple keys by incrementing the number at the end, for example, sortCol1, asc2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_sort).", "type": "object" }, "runtime_param_override": { "description": "JSON object for setting values of parameters at runtime. For example, {\"param1\": \"Double List Param\", \"paramVal1\": 0.5}. You can add multiple keys by incrementing the number at the end, for example, param2, paramVal2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_parameters).", "type": "object" } }, "required": [ "metadata_identifier" ] }, "SearchDataRequest": { "type": "object", "properties": { "query_string": { "description": "Query string with search tokens. For example, [Sales][Region]. See [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_search_data_api)", "type": "string" }, "logical_table_identifier": { "description": "GUID of the data source object, such as a Worksheet, View, or Table. You can find the GUID of a data object from the UI or via API. See [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_search_query) for more details.", "type": "string" }, "data_format": { "description": "JSON output in compact or full format. The FULL option is available in 9.12.5.cl or later.", "default": "COMPACT", "type": "string", "enum": [ "FULL", "COMPACT" ] }, "record_offset": { "description": "The starting record number from where the records should be included.", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "The number of records to include in a batch.", "default": 10, "type": "integer", "format": "int32" }, "runtime_filter": { "description": "JSON object with representing filter condition to apply filters at runtime. For example, {\"col1\": \"item type\", \"op1\": \"EQ\", \"val1\": \"Bags\"} . You can add multiple keys by incrementing the number at the end, for example, col2, op2, val2, and col3, op3, val3. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_filters).", "type": "object" }, "runtime_sort": { "description": "JSON object representing columns to sort data at runtime. For example, {\"sortCol1\": \"sales\", \"asc1\": true} . You can add multiple keys by incrementing the number at the end, for example, sortCol1, asc2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_sort).", "type": "object" }, "runtime_param_override": { "description": "JSON object for setting values of parameters at runtime. For example, {\"param1\": \"Double List Param\", \"paramVal1\": 0.5}. You can add multiple keys by incrementing the number at the end, for example, param2, paramVal2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_parameters).", "type": "object" } }, "required": [ "query_string", "logical_table_identifier" ] }, "CreateEmailCustomizationRequest": { "type": "object", "properties": { "template_properties": { "description": "Email customization configuration as key value pair", "allOf": [ { "$ref": "#/components/schemas/Template_Properties_Input_Create" } ] }, "org_identifier": { "description": "Unique ID or name of org
Version: 10.12.0.cl or later", "type": "string" } }, "required": [ "template_properties" ] }, "DeleteOrgEmailCustomizationRequest": { "type": "object", "properties": { "org_identifiers": { "description": "Unique identifier of the organization.", "type": "array", "items": { "type": "string" } } } }, "SearchEmailCustomizationRequest": { "type": "object", "properties": { "org_identifiers": { "description": "Unique ID or name of org
Version: 10.12.0.cl or later", "type": "array", "items": { "type": "string" } } } }, "UpdateEmailCustomizationRequest": { "type": "object", "properties": { "template_properties": { "description": "Email customization configuration as key value pair", "allOf": [ { "$ref": "#/components/schemas/Template_Properties_Input_Create" } ] }, "org_identifier": { "description": "Unique ID or name of org", "type": "string" } }, "required": [ "template_properties" ] }, "SearchFeaturesRequest": { "type": "object", "properties": { "scope": { "description": "Determines the administrative view for the search.\nUse CLUSTER for the cluster-admin view (returns org assignments per feature);\nuse ORG for the org-admin view (returns the current value of each feature\nassigned to the org).", "type": "string", "enum": [ "CLUSTER", "ORG" ] }, "org_identifier": { "description": "Numeric ID of the Org to scope the search to. Required when scope is ORG;\nignored when scope is CLUSTER.", "type": "integer", "format": "int32" }, "category": { "description": "Category of features to return. GENERAL_ACCESS returns features that are\ngenerally available; EARLY_ACCESS returns features still in early access.\nDefaults to GENERAL_ACCESS.", "default": "GENERAL_ACCESS", "type": "string", "enum": [ "GENERAL_ACCESS", "EARLY_ACCESS" ] } }, "required": [ "scope" ] }, "UpdateFeatureAssignmentsRequest": { "type": "object", "properties": { "feature_identifier": { "description": "User-friendly feature name (feature_name) or the underlying feature ID\n(feature_id) of the feature whose Org assignments should be updated.", "type": "string" }, "org_identifiers": { "description": "Numeric IDs of the Orgs to assign to the feature. Send an empty array with\noperation REPLACE to clear all Org assignments for this feature.", "type": "array", "items": { "type": "integer", "format": "int32" } }, "operation": { "description": "Type of update to apply to the Org assignments. ADD assigns the given Orgs\nin addition to existing ones; REMOVE unassigns the given Orgs; REPLACE sets\nthe assignment to exactly the given Orgs. Defaults to REPLACE.", "default": "REPLACE", "type": "string", "enum": [ "ADD", "REMOVE", "REPLACE" ] } }, "required": [ "feature_identifier", "org_identifiers" ] }, "UpdateFeatureValueRequest": { "type": "object", "properties": { "scope": { "description": "Determines the scope at which the value is set. Use CLUSTER to set the\ncluster-level value; use ORG to set a per-Org value override.", "type": "string", "enum": [ "CLUSTER", "ORG" ] }, "org_identifier": { "description": "Numeric ID of the Org for which to set the value. Required when scope is\nORG; ignored when scope is CLUSTER.", "type": "integer", "format": "int32" }, "feature_identifier": { "description": "User-friendly feature name (feature_name) or the underlying feature ID\n(feature_id) of the feature whose value should be set.", "type": "string" }, "feature_value": { "description": "New value to set for the feature.", "type": "string" }, "reset_org_overrides": { "description": "Applicable only when `scope` is `CLUSTER`. When `true`, any existing per-Org value overrides for this feature are removed so that all Orgs inherit the new cluster-level value. Required when `scope` is `CLUSTER` for an org-aware feature. Must be omitted when `scope` is `ORG`; passing it at `ORG` scope returns a 400 error.", "type": "boolean", "nullable": true } }, "required": [ "scope", "feature_identifier", "feature_value" ] }, "CreateUserGroupRequest": { "type": "object", "properties": { "name": { "description": "Name of the group. The group name must be unique.", "type": "string" }, "display_name": { "description": "Display name for the group.", "type": "string" }, "default_liveboard_identifiers": { "description": "GUID of the Liveboards to assign as default Liveboards to the users in the group.", "type": "array", "items": { "type": "string" } }, "description": { "description": "Description of the group", "type": "string" }, "privileges": { "description": "Privileges to assign to the group. Note: AUTHORING is a no-op — always inherited via ALL_GROUP, assigning it has no effect.", "type": "array", "items": { "type": "string", "enum": [ "ADMINISTRATION", "AUTHORING", "USERDATAUPLOADING", "DATADOWNLOADING", "USERMANAGEMENT", "DATAMANAGEMENT", "SHAREWITHALL", "JOBSCHEDULING", "A3ANALYSIS", "EXPERIMENTALFEATUREPRIVILEGE", "BYPASSRLS", "RANALYSIS", "DEVELOPER", "USER_ADMINISTRATION", "GROUP_ADMINISTRATION", "SYNCMANAGEMENT", "CAN_CREATE_CATALOG", "DISABLE_PINBOARD_CREATION", "LIVEBOARD_VERIFIER", "PREVIEW_THOUGHTSPOT_SAGE", "CAN_MANAGE_VERSION_CONTROL", "THIRDPARTY_ANALYSIS", "ALLOW_NON_EMBED_FULL_APP_ACCESS", "CAN_ACCESS_ANALYST_STUDIO", "CAN_MANAGE_ANALYST_STUDIO", "CAN_MODIFY_FOLDERS", "CAN_MANAGE_VARIABLES", "CAN_VIEW_FOLDERS", "CAN_MANAGE_AGENTSPOT", "CAN_ACCESS_AGENTSPOT", "PREVIEW_DOCUMENT_SEARCH", "CAN_SETUP_VERSION_CONTROL", "CAN_DOWNLOAD_VISUALS", "CAN_DOWNLOAD_DETAILED_DATA", "CAN_USE_SPOTTER", "CAN_MANAGE_SPOTTER", "CAN_CREATE_LIVEBOARD", "CAN_CREATE_ANSWERS", "CAN_ANALYZE_DATA", "CAN_ADMINISTER_SCHEDULES", "CAN_CREATE_KPI_ALERTS" ] } }, "sub_group_identifiers": { "description": "GUID or name of the sub groups. A subgroup is a group assigned to a parent group.", "type": "array", "items": { "type": "string" } }, "type": { "description": "Group type.", "default": "LOCAL_GROUP", "type": "string", "enum": [ "LOCAL_GROUP", "LDAP_GROUP", "TEAM_GROUP", "TENANT_GROUP" ] }, "user_identifiers": { "description": "GUID or name of the users to assign to the group.", "type": "array", "items": { "type": "string" } }, "visibility": { "description": "Visibility of the group. To make a group visible to other users and groups,\nset the visibility to SHAREABLE.", "default": "SHARABLE", "type": "string", "enum": [ "SHARABLE", "NON_SHARABLE" ] }, "role_identifiers": { "description": "Role identifiers of the roles that should be assigned to the group.", "type": "array", "items": { "type": "string" } } }, "required": [ "name", "display_name" ] }, "ImportUserGroupsRequest": { "type": "object", "properties": { "groups": { "description": "Details of groups which are to be imported", "type": "array", "items": { "$ref": "#/components/schemas/GroupsImportListInput" } }, "delete_unspecified_groups": { "description": "If set to true, removes groups that are not specified in the API request.", "default": false, "type": "boolean", "nullable": true }, "dry_run": { "description": "If true, the API performs a test operation and returns user IDs whose\ndata will be edited after the import.", "default": true, "type": "boolean", "nullable": true } } }, "SearchUserGroupsRequest": { "type": "object", "properties": { "default_liveboard_identifiers": { "description": "GUID of Liveboards that are assigned as default Liveboards to the users in the group.", "type": "array", "items": { "type": "string" } }, "description": { "description": "Description of the group", "type": "string" }, "display_name": { "description": "Display name of the group", "type": "string" }, "name_pattern": { "description": "A pattern to match case-insensitive name of the Group object.", "type": "string" }, "group_identifier": { "description": "GUID or name of the group", "type": "string" }, "org_identifiers": { "description": "ID or name of the Org to which the group belongs", "type": "array", "items": { "type": "string" } }, "privileges": { "description": "Privileges assigned to the group.", "type": "array", "items": { "type": "string", "enum": [ "ADMINISTRATION", "AUTHORING", "USERDATAUPLOADING", "DATADOWNLOADING", "USERMANAGEMENT", "DATAMANAGEMENT", "SHAREWITHALL", "JOBSCHEDULING", "A3ANALYSIS", "EXPERIMENTALFEATUREPRIVILEGE", "BYPASSRLS", "RANALYSIS", "DEVELOPER", "USER_ADMINISTRATION", "GROUP_ADMINISTRATION", "SYNCMANAGEMENT", "CAN_CREATE_CATALOG", "DISABLE_PINBOARD_CREATION", "LIVEBOARD_VERIFIER", "PREVIEW_THOUGHTSPOT_SAGE", "APPLICATION_ADMINISTRATION", "SYSTEM_INFO_ADMINISTRATION", "ORG_ADMINISTRATION", "ROLE_ADMINISTRATION", "AUTHENTICATION_ADMINISTRATION", "BILLING_INFO_ADMINISTRATION", "CAN_MANAGE_CUSTOM_CALENDAR", "CAN_CREATE_OR_EDIT_CONNECTIONS", "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", "CAN_MANAGE_VERSION_CONTROL", "THIRDPARTY_ANALYSIS", "ALLOW_NON_EMBED_FULL_APP_ACCESS", "CAN_ACCESS_ANALYST_STUDIO", "CAN_MANAGE_ANALYST_STUDIO", "PREVIEW_DOCUMENT_SEARCH", "CAN_MODIFY_FOLDERS", "CAN_MANAGE_VARIABLES", "CAN_VIEW_FOLDERS", "CAN_MANAGE_AGENTSPOT", "CAN_ACCESS_AGENTSPOT", "CAN_SETUP_VERSION_CONTROL", "CAN_MANAGE_WEBHOOKS", "CAN_DOWNLOAD_VISUALS", "CAN_DOWNLOAD_DETAILED_DATA", "CAN_USE_SPOTTER", "CAN_MANAGE_SPOTTER", "CAN_CREATE_LIVEBOARD", "CAN_CREATE_ANSWERS", "CAN_ANALYZE_DATA", "CAN_ADMINISTER_SCHEDULES", "CAN_CREATE_KPI_ALERTS" ] } }, "sub_group_identifiers": { "description": "GUID or name of the sub groups. A subgroup is a group assigned to a parent group.", "type": "array", "items": { "type": "string" } }, "type": { "description": "Group type.", "type": "string", "enum": [ "LOCAL_GROUP", "LDAP_GROUP", "TEAM_GROUP", "TENANT_GROUP" ] }, "user_identifiers": { "description": "GUID or name of the users assigned to the group.", "type": "array", "items": { "type": "string" } }, "visibility": { "description": "Visibility of the group. To make a group visible to other users and groups,\nset the visibility to SHAREABLE.", "type": "string", "enum": [ "SHARABLE", "NON_SHARABLE" ] }, "role_identifiers": { "description": "Filter groups with a list of Roles assigned to a group", "type": "array", "items": { "type": "string" } }, "record_offset": { "description": "The starting record number from where the records should be included.", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "The number of records that should be included.", "default": 10, "type": "integer", "format": "int32" }, "sort_options": { "description": "Sort options to filter group details.", "allOf": [ { "$ref": "#/components/schemas/SortOptions" } ] }, "include_users": { "description": "
Version: 10.10.0.cl or later
\n\nDefine Parameter to consider if the users should be included in group search response.", "default": true, "type": "boolean", "nullable": true }, "include_sub_groups": { "description": "
Version: 10.10.0.cl or later
\n\nDefine Parameter to consider if the sub groups should be included in group search response.", "default": true, "type": "boolean", "nullable": true } } }, "UpdateUserGroupRequest": { "type": "object", "properties": { "name": { "description": "Name of the group to modify.", "type": "string" }, "default_liveboard_identifiers": { "description": "ID of the Liveboards to be assigned as default Liveboards to the users in the group.", "type": "array", "items": { "type": "string" } }, "description": { "description": "Description for the group.", "type": "string" }, "display_name": { "description": "Display name of the group.", "type": "string" }, "privileges": { "description": "Privileges to assign to the group. Note: AUTHORING is a no-op — always inherited via ALL_GROUP, assigning it has no effect.", "type": "array", "items": { "type": "string", "enum": [ "ADMINISTRATION", "AUTHORING", "USERDATAUPLOADING", "DATADOWNLOADING", "USERMANAGEMENT", "DATAMANAGEMENT", "SHAREWITHALL", "JOBSCHEDULING", "A3ANALYSIS", "EXPERIMENTALFEATUREPRIVILEGE", "BYPASSRLS", "RANALYSIS", "DEVELOPER", "USER_ADMINISTRATION", "GROUP_ADMINISTRATION", "SYNCMANAGEMENT", "CAN_CREATE_CATALOG", "DISABLE_PINBOARD_CREATION", "LIVEBOARD_VERIFIER", "PREVIEW_THOUGHTSPOT_SAGE", "CAN_MANAGE_VERSION_CONTROL", "THIRDPARTY_ANALYSIS", "ALLOW_NON_EMBED_FULL_APP_ACCESS", "CAN_ACCESS_ANALYST_STUDIO", "CAN_MANAGE_ANALYST_STUDIO", "CAN_MODIFY_FOLDERS", "CAN_MANAGE_VARIABLES", "CAN_VIEW_FOLDERS", "CAN_MANAGE_AGENTSPOT", "CAN_ACCESS_AGENTSPOT", "PREVIEW_DOCUMENT_SEARCH", "CAN_SETUP_VERSION_CONTROL", "CAN_DOWNLOAD_VISUALS", "CAN_DOWNLOAD_DETAILED_DATA", "CAN_USE_SPOTTER", "CAN_MANAGE_SPOTTER", "CAN_CREATE_LIVEBOARD", "CAN_CREATE_ANSWERS", "CAN_ANALYZE_DATA", "CAN_ADMINISTER_SCHEDULES", "CAN_CREATE_KPI_ALERTS" ] } }, "sub_group_identifiers": { "description": "GUID or name of the sub groups. A subgroup is a group assigned to a parent group.", "type": "array", "items": { "type": "string" } }, "type": { "description": "Type of the group", "type": "string", "enum": [ "LOCAL_GROUP", "LDAP_GROUP", "TEAM_GROUP", "TENANT_GROUP" ] }, "user_identifiers": { "description": "GUID or name of the users to assign to the group.", "type": "array", "items": { "type": "string" } }, "visibility": { "description": "Visibility of the group. To make a group visible to other users and\ngroups, set the visibility to SHAREABLE.", "type": "string", "enum": [ "SHARABLE", "NON_SHARABLE" ] }, "role_identifiers": { "description": "Role identifiers of the Roles that should be assigned to the group.", "type": "array", "items": { "type": "string" } }, "operation": { "description": "Type of update operation. Default operation type is REPLACE", "default": "REPLACE", "type": "string", "enum": [ "ADD", "REMOVE", "REPLACE" ] } } }, "SearchChannelHistoryRequest": { "type": "object", "properties": { "channel_type": { "description": "Type of communication channel to search history for.", "type": "string", "enum": [ "WEBHOOK" ] }, "job_ids": { "description": "List of job execution record IDs to retrieve.", "type": "array", "items": { "type": "string" } }, "channel_identifiers": { "description": "List of channel IDs or names to filter by.", "type": "array", "items": { "type": "string" } }, "channel_status": { "description": "Filter by channel delivery status.", "type": "string", "enum": [ "PENDING", "RETRY", "SUCCESS", "FAILED" ] }, "events": { "description": "Filter by events that triggered the channel.", "type": "array", "items": { "$ref": "#/components/schemas/ChannelHistoryEventInput" } }, "start_epoch_time_in_millis": { "description": "Filter records created on or after this time (epoch milliseconds).", "type": "number", "format": "float" }, "end_epoch_time_in_millis": { "description": "Filter records created before this time (epoch milliseconds).
Version: 26.7.0.cl or later", "type": "number", "format": "float" } }, "required": [ "channel_type" ] }, "FetchLogsRequest": { "type": "object", "properties": { "log_type": { "description": "Name of the log type", "type": "string", "enum": [ "SECURITY_AUDIT" ] }, "start_epoch_time_in_millis": { "description": "Start time in EPOCH format", "type": "number", "format": "float" }, "end_epoch_time_in_millis": { "description": "End time in EPOCH format", "type": "number", "format": "float" }, "get_all_logs": { "description": "Fetch all the logs. This is available from 9.10.5.cl", "default": true, "type": "boolean", "nullable": true } }, "required": [ "log_type" ] }, "DeleteManualTranslationsRequest": { "type": "object", "properties": { "scope": { "description": "Org scope for the delete. `ORG` (default) targets the calling\nuser's current org. `CLUSTER` targets the All-Org context.", "default": "ORG", "type": "string", "enum": [ "ORG", "CLUSTER" ] } } }, "ExportManualTranslationsRequest": { "type": "object", "properties": { "scope": { "description": "Org scope for the export. `ORG` (default) targets the calling\nuser's current org. `CLUSTER` targets the All-Org context.", "default": "ORG", "type": "string", "enum": [ "ORG", "CLUSTER" ] } } }, "ConvertWorksheetToModelRequest": { "type": "object", "properties": { "worksheet_ids": { "description": "List of Worksheet IDs.", "type": "array", "items": { "type": "string" } }, "exclude_worksheet_ids": { "description": "List of Worksheet IDs to be excluded.", "type": "array", "items": { "type": "string" } }, "convert_all": { "description": "Indicates whether all the worksheet needs to be converted to models.", "default": false, "type": "boolean", "nullable": true }, "apply_changes": { "description": "Indicates whether the changes should be applied to database.", "default": false, "type": "boolean", "nullable": true } } }, "CopyObjectRequest": { "type": "object", "properties": { "description": { "description": "Description of the new object", "type": "string" }, "identifier": { "description": "GUID of metadata object to be copied (answer id or liveboard id)", "type": "string" }, "type": { "description": "Type of metadata object", "type": "string", "enum": [ "LIVEBOARD", "ANSWER" ] }, "title": { "description": "Title of the new object", "type": "string" } }, "required": [ "identifier" ] }, "DeleteMetadataRequest": { "type": "object", "properties": { "metadata": { "description": "Metadata objects.", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMetadataTypeInput" } }, "delete_disabled_objects": { "description": "Indicates whether to delete disabled metadata objects.", "default": false, "type": "boolean", "nullable": true } }, "required": [ "metadata" ] }, "ExportMetadataTMLRequest": { "type": "object", "properties": { "metadata": { "description": "Metadata objects.", "type": "array", "items": { "$ref": "#/components/schemas/ExportMetadataTypeInput" } }, "export_associated": { "description": "Indicates whether to export associated metadata objects of specified metadata objects.", "default": false, "type": "boolean", "nullable": true }, "export_fqn": { "description": "Adds FQNs of the referenced objects. For example, if you are exporting a Liveboard and its associated objects,\nthe API returns the Liveboard TML data with the FQNs of the referenced worksheet.\nIf the exported TML data includes FQNs, you don't need to manually add FQNs of the referenced objects during TML import.", "default": false, "type": "boolean", "nullable": true }, "edoc_format": { "description": "TML EDOC content format.\n\n**Note: exporting in YAML format currently requires manual formatting of the output. For more details on the workaround, please click [here](https://developers.thoughtspot.com/docs/known-issues#_version_9_12_0_cl)**", "default": "JSON", "type": "string", "enum": [ "JSON", "YAML" ] }, "export_schema_version": { "description": "Indicates whether to export worksheet TML in DEFAULT or V1 or V2 version.", "default": "DEFAULT", "type": "string", "enum": [ "DEFAULT", "V1", "V2" ] }, "export_dependent": { "description": "Indicates whether to export table while exporting connection.", "default": false, "type": "boolean", "nullable": true }, "export_connection_as_dependent": { "description": "Indicates whether to export connection as dependent while exporting table/worksheet/answer/liveboard.\nThis will only be active when export_associated is true.", "default": false, "type": "boolean", "nullable": true }, "all_orgs_override": { "description": "Indicates whether to export is happening from all orgs context.", "default": false, "type": "boolean", "nullable": true }, "export_options": { "description": "Flags to specify additional options for export.
Version: 10.6.0.cl or later", "allOf": [ { "$ref": "#/components/schemas/Export_Options" } ] } }, "required": [ "metadata" ] }, "ExportMetadataTMLBatchedRequest": { "type": "object", "properties": { "metadata_type": { "description": "Type of metadata object to export, can be one of USER | ROLE | USER_GROUP", "type": "string", "enum": [ "USER", "USER_GROUP", "ROLE" ] }, "batch_offset": { "description": "Indicates the position within the complete set from where the API should begin returning objects.", "default": 0, "type": "integer", "format": "int32" }, "batch_size": { "description": "Determines the number of objects or items to be retrieved in a single request.", "default": 20, "type": "integer", "format": "int32" }, "edoc_format": { "description": "TML EDOC content format.", "default": "JSON", "type": "string", "enum": [ "JSON", "YAML" ] }, "export_dependent": { "description": "Indicates whether to export dependent metadata objects of specified metadata objects.", "default": false, "type": "boolean", "nullable": true }, "all_orgs_override": { "description": "Indicates whether to export is happening from all orgs context.", "default": false, "type": "boolean", "nullable": true } }, "required": [ "metadata_type" ] }, "FetchAnswerSqlQueryRequest": { "type": "object", "properties": { "metadata_identifier": { "description": "ID or name of an Answer.", "type": "string" } }, "required": [ "metadata_identifier" ] }, "FetchAsyncImportTaskStatusRequest": { "type": "object", "properties": { "task_ids": { "description": "List of task IDs to fetch status for.", "type": "array", "items": { "type": "string" } }, "task_status": { "description": "List of task statuses to filter on. Valid values: [IN_QUEUE, IN_PROGRESS, COMPLETED, FAILED]", "type": "array", "items": { "type": "string", "enum": [ "COMPLETED", "IN_QUEUE", "IN_PROGRESS", "FAILED" ] } }, "author_identifier": { "description": "Author GUID or name of async import tasks to filter on.", "type": "string" }, "record_offset": { "description": "The offset point, starting from where the task status should be included in the response.", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "The number of task statuses that should be included in the response starting from offset position.", "default": 5, "type": "integer", "format": "int32" }, "include_import_response": { "description": "Boolean flag to specify whether to include import response in the task status objects.", "default": false, "type": "boolean", "nullable": true } } }, "FetchLiveboardSqlQueryRequest": { "type": "object", "properties": { "metadata_identifier": { "description": "ID or name of the Liveboard.", "type": "string" }, "visualization_identifiers": { "description": "Unique ID or name of visualizations.", "type": "array", "items": { "type": "string" } } }, "required": [ "metadata_identifier" ] }, "ImportMetadataTMLRequest": { "type": "object", "properties": { "metadata_tmls": { "description": "Details of TML objects.\n\n**Note: importing TML in YAML format, when coming directly from our Playground, is currently requires manual formatting. For more details on the workaround, please click [here](https://developers.thoughtspot.com/docs/known-issues#_version_9_12_0_cl)**", "type": "array", "items": { "type": "string" } }, "import_policy": { "description": "Specifies the import policy for the TML import.", "default": "PARTIAL", "type": "string", "enum": [ "PARTIAL", "ALL_OR_NONE", "VALIDATE_ONLY", "PARTIAL_OBJECT" ] }, "create_new": { "description": "If selected, creates TML objects with new GUIDs.", "default": false, "type": "boolean", "nullable": true }, "all_orgs_override": { "description": "If import is happening from all orgs context.", "default": false, "type": "boolean", "nullable": true }, "skip_diff_check": { "description": "
Version: 10.6.0.cl or later
\n\nBoolean Flag to skip TML diff check before processing object TMLs.", "default": false, "type": "boolean", "nullable": true }, "enable_large_metadata_validation": { "description": "
Version: 10.5.0.cl or later
\n\nBoolean to indicate if the large metadata validation should be enabled.", "default": false, "type": "boolean", "nullable": true }, "enable_personalized_view_upsert": { "description": "
Version: 26.8.0.cl or later
\n\nBoolean flag to enable update/insert of personalized views in liveboard.", "default": false, "type": "boolean", "nullable": true } }, "required": [ "metadata_tmls" ] }, "ImportMetadataTMLAsyncRequest": { "type": "object", "properties": { "metadata_tmls": { "description": "Details of TML objects.", "type": "array", "items": { "type": "string" } }, "create_new": { "description": "If selected, creates TML objects with new GUIDs.", "default": false, "type": "boolean", "nullable": true }, "all_orgs_override": { "description": "If import is happening from all orgs context.", "default": false, "type": "boolean", "nullable": true }, "import_policy": { "description": "
Version: 10.5.0.cl or later
\n\nPolicy to be followed while importing the TML. Valid values are [PARTIAL_OBJECT, PARTIAL, VALIDATE_ONLY, ALL_OR_NONE]", "default": "PARTIAL_OBJECT", "type": "string", "enum": [ "PARTIAL", "ALL_OR_NONE", "VALIDATE_ONLY", "PARTIAL_OBJECT" ] }, "skip_diff_check": { "description": "
Version: 10.6.0.cl or later
\n\nBoolean Flag to skip TML diff check before processing object TMLs.", "default": false, "type": "boolean", "nullable": true }, "enable_large_metadata_validation": { "description": "
Version: 10.5.0.cl or later
\n\nBoolean to indicate if the large metadata validation should be enabled.", "default": false, "type": "boolean", "nullable": true }, "enable_personalized_view_upsert": { "description": "
Version: 26.8.0.cl or later
\n\nBoolean flag to enable update/insert of personalized views in liveboard.", "default": false, "type": "boolean", "nullable": true } }, "required": [ "metadata_tmls" ] }, "ParameterizeMetadataRequest": { "type": "object", "properties": { "metadata_type": { "description": "Type of metadata object to parameterize.", "type": "string", "enum": [ "LOGICAL_TABLE", "CONNECTION", "CONNECTION_CONFIG" ] }, "metadata_identifier": { "description": "Unique ID or name of the metadata object to parameterize.", "type": "string" }, "field_type": { "description": "Type of field in the metadata to parameterize.", "type": "string", "enum": [ "ATTRIBUTE", "CONNECTION_PROPERTY" ] }, "field_name": { "description": "Name of the field which needs to be parameterized.", "type": "string" }, "variable_identifier": { "description": "Unique ID or name of the variable to use for parameterization", "type": "string" } }, "required": [ "metadata_identifier", "field_type", "field_name", "variable_identifier" ] }, "ParameterizeMetadataFieldsRequest": { "type": "object", "properties": { "metadata_type": { "description": "Type of metadata object to parameterize.", "type": "string", "enum": [ "LOGICAL_TABLE", "CONNECTION", "CONNECTION_CONFIG" ] }, "metadata_identifier": { "description": "Unique ID or name of the metadata object to parameterize.", "type": "string" }, "field_type": { "description": "Type of field in the metadata to parameterize.", "type": "string", "enum": [ "ATTRIBUTE", "CONNECTION_PROPERTY" ] }, "field_names": { "description": "JSON array of field names to parameterize. Example: [schemaName, databaseName, tableName]", "type": "array", "items": { "type": "string" } }, "variable_identifier": { "description": "Unique ID or name of the variable to use for parameterization of these fields.", "type": "string" } }, "required": [ "metadata_identifier", "field_type", "field_names", "variable_identifier" ] }, "SearchMetadataRequest": { "type": "object", "properties": { "metadata": { "description": "Metadata objects such as Liveboards, Answers, and Worksheets.", "type": "array", "items": { "$ref": "#/components/schemas/MetadataListItemInput" } }, "permissions": { "description": "Object permission details to search by.", "type": "array", "items": { "$ref": "#/components/schemas/PermissionInput" } }, "created_by_user_identifiers": { "description": "GUID or name of user who created the metadata object.", "type": "array", "items": { "type": "string" } }, "dependent_object_version": { "description": "Version of the dependent table of the metadata objects like Worksheets.", "default": "V1", "type": "string", "enum": [ "V1", "V2" ] }, "exclude_objects": { "description": "List of metadata objects to exclude from search.", "type": "array", "items": { "$ref": "#/components/schemas/ExcludeMetadataListItemInput" } }, "favorite_object_options": { "description": "Options to sort the API response by objects set as favorites\nfor the logged-in user or the users specified in the API request.", "allOf": [ { "$ref": "#/components/schemas/FavoriteObjectOptionsInput" } ] }, "include_auto_created_objects": { "description": "Includes system-generated metadata objects.", "default": false, "type": "boolean", "nullable": true }, "include_dependent_objects": { "description": "Includes dependents of the metadata object specified in the API request.\nFor example, a worksheet can consist of dependent objects such as Liveboards or Answers.", "default": false, "type": "boolean", "nullable": true }, "dependent_objects_record_size": { "description": "The maximum number of dependents to include per metadata object.", "default": 50, "type": "integer", "format": "int32" }, "include_details": { "description": "Includes complete details of the metadata objects.", "default": false, "type": "boolean", "nullable": true }, "include_personalised_views": { "description": "When set to true and include_details is also true, includes personalised views\nin the metadata_detail for LIVEBOARD objects. Personalised views are also included\nwhen liveboard_details.personalized_views is true.", "default": false, "type": "boolean", "nullable": true }, "liveboard_details": { "description": "
Version: 26.10.0.cl or later
\n\nSelects which parts of a Liveboard's `metadata_detail` are returned, so that a request can skip the parts it does not need.\n\nApplies only to `LIVEBOARD` objects, and only when `include_details` is `true` and `liveboard_response_version` is `V2`. Otherwise it is ignored.\n\n* `liveboard_filters`, `liveboard_tabs`, `container_layouts`, `visualizations`, `parameter_overrides`: default to `true`. Set a field to `false` to exclude that part of the Liveboard.\n* `personalized_views`: defaults to `false`. Personalised views are included when either this field or `include_personalised_views` is `true`.\n\nThe Liveboard header, type, and style are always returned. Excluded collections are returned empty.\n\nTo fetch only the personalised views of a Liveboard, set every other field to `false`. The Liveboard definition is then not loaded, and `metadata_detail` contains only `personalised_views`:\n\n```json\n\"liveboard_details\": {\n \"liveboard_filters\": false,\n \"liveboard_tabs\": false,\n \"container_layouts\": false,\n \"visualizations\": false,\n \"parameter_overrides\": false,\n \"personalized_views\": true\n}\n```", "allOf": [ { "$ref": "#/components/schemas/LiveboardDetailsInput" } ] }, "include_headers": { "description": "Includes headers of the metadata objects.", "default": true, "type": "boolean", "nullable": true }, "include_hidden_objects": { "description": "Includes details of the hidden objects, such as a column in a worksheet or a table.", "default": false, "type": "boolean", "nullable": true }, "include_incomplete_objects": { "description": "Includes objects with incomplete metadata.", "default": false, "type": "boolean", "nullable": true }, "include_visualization_headers": { "description": "Includes visualization headers of the specified Liveboard object.", "default": false, "type": "boolean", "nullable": true }, "include_worksheet_search_assist_data": { "description": "If search assistance lessons are configured on a worksheet,\nthe API returns the search assist data for Worksheet objects.", "type": "boolean", "nullable": true }, "modified_by_user_identifiers": { "description": "Includes ID or names of the users who modified the metadata object.", "type": "array", "items": { "type": "string" } }, "record_offset": { "description": "The starting record number from where the records should be included.", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "The number of records that should be included. It is recommended to use a smaller `record_size` when fetching dependent objects or any of the additional metadata detail options.", "default": 10, "type": "integer", "format": "int32" }, "sort_options": { "description": "Sort options to filter metadata details.", "allOf": [ { "$ref": "#/components/schemas/MetadataSearchSortOptions" } ] }, "tag_identifiers": { "description": "Tags to filter metadata objects by", "type": "array", "items": { "type": "string" } }, "include_stats": { "description": "Indicates whether to include stats of the metadata objects.", "default": false, "type": "boolean", "nullable": true }, "include_discoverable_objects": { "description": "
Version: 10.7.0.cl or later
\n\nBoolean to indicate whether to include discoverable metadata objects.", "default": true, "type": "boolean", "nullable": true }, "show_resolved_parameters": { "description": "
Version: 10.9.0.cl or later
\n\nIndicates whether to show resolved parameterised values.", "default": false, "type": "boolean", "nullable": true }, "liveboard_response_version": { "description": "Indicates the model version of Liveboard to be attached in metadata detail.", "default": "V1", "type": "string", "enum": [ "V1", "V2" ] }, "include_only_published_objects": { "description": "
Version: 10.11.0.cl or later
\n\nIf only published objects should be returned", "default": false, "type": "boolean", "nullable": true } } }, "UnparameterizeMetadataRequest": { "type": "object", "properties": { "metadata_type": { "description": "Type of metadata object to unparameterize.", "type": "string", "enum": [ "LOGICAL_TABLE", "CONNECTION", "CONNECTION_CONFIG" ] }, "metadata_identifier": { "description": "Unique ID or name of the metadata object to unparameterize.", "type": "string" }, "field_type": { "description": "Type of field in the metadata to unparameterize.", "type": "string", "enum": [ "ATTRIBUTE", "CONNECTION_PROPERTY" ] }, "field_name": { "description": "Name of the field which needs to be unparameterized.", "type": "string" }, "value": { "description": "The value to use in place of the variable for the field", "type": "string" } }, "required": [ "metadata_identifier", "field_type", "field_name", "value" ] }, "UpdateMetadataHeaderRequest": { "type": "object", "properties": { "headers_update": { "description": "List of header objects to update.", "type": "array", "items": { "$ref": "#/components/schemas/HeaderUpdateInput" } }, "org_identifier": { "description": "Unique ID or name of the organization.", "type": "string" } }, "required": [ "headers_update" ] }, "UpdateMetadataObjIdRequest": { "type": "object", "properties": { "metadata": { "description": "List of metadata objects to update their object IDs.", "type": "array", "items": { "$ref": "#/components/schemas/UpdateObjIdInput" } } }, "required": [ "metadata" ] }, "CreateOrgRequest": { "type": "object", "properties": { "name": { "description": "Name of the Org.", "type": "string" }, "description": { "description": "Description of the Org.", "type": "string" } }, "required": [ "name" ] }, "SearchOrgsRequest": { "type": "object", "properties": { "org_identifier": { "description": "ID or name of the Org", "type": "string" }, "description": { "description": "Description of the Org", "type": "string" }, "visibility": { "description": "Visibility of the Org", "type": "string", "enum": [ "SHOW", "HIDDEN" ] }, "status": { "description": "Status of the Org", "type": "string", "enum": [ "ACTIVE", "IN_ACTIVE" ] }, "user_identifiers": { "description": "GUIDs or names of the users for which you want to retrieve the Orgs data", "type": "array", "items": { "type": "string" } } } }, "UpdateOrgRequest": { "type": "object", "properties": { "name": { "description": "Name of the Org", "type": "string" }, "description": { "description": "Description of the Org", "type": "string" }, "user_identifiers": { "description": "Add Users to an Org", "type": "array", "items": { "type": "string" } }, "group_identifiers": { "description": "Add Default Groups to an Org", "type": "array", "items": { "type": "string" } }, "operation": { "description": "Type of update operation. Default operation type is ADD", "default": "ADD", "type": "string", "enum": [ "ADD", "REMOVE", "REPLACE" ] } } }, "ExportAnswerReportRequest": { "type": "object", "properties": { "metadata_identifier": { "description": "Unique ID or name of the metadata object.", "type": "string" }, "session_identifier": { "description": "Unique ID of the answer session.", "type": "string" }, "generation_number": { "description": "Generation number of the answer session.", "type": "integer", "format": "int32" }, "file_format": { "description": "Export file format.", "default": "CSV", "type": "string", "enum": [ "CSV", "PDF", "XLSX", "PNG" ] }, "runtime_filter": { "description": "JSON string representing runtime filter.\n{ col1:region, op1: EQ, val1: northeast }", "type": "object" }, "runtime_sort": { "description": "JSON string representing runtime sort.\n{ sortCol1: region, asc1 :true, sortCol2 : date }", "type": "object" }, "runtime_param_override": { "description": "JSON object for setting values of parameters in runtime.", "type": "object" }, "regional_settings": { "description": "Options for specific region specific overrides to support date/number/string/currency formatting.", "allOf": [ { "$ref": "#/components/schemas/RegionalSettingsInput" } ] }, "png_options": { "description": "Options for PNG export.
Beta Version: 26.6.0.cl or later", "allOf": [ { "$ref": "#/components/schemas/AnswerPngOptionsInput" } ] }, "personalised_view_identifier": { "description": "GUID or name of the personalised view of the Answer object.
Beta Version: 26.6.0.cl or later", "type": "string" }, "type": { "description": "Type of the answer being exported.
Beta Version: 26.6.0.cl or later", "default": "SAVED", "type": "string", "enum": [ "SAVED", "PINNED" ] } } }, "ExportLiveboardReportRequest": { "type": "object", "properties": { "metadata_identifier": { "description": "GUID or name of the Liveboard object.", "type": "string" }, "tab_identifiers": { "description": "GUID or name of the tab of the Liveboard object.
Version: 10.9.0.cl or later", "type": "array", "items": { "type": "string" } }, "personalised_view_identifier": { "description": "GUID or name of the personalised view of the Liveboard object.
Version: 10.9.0.cl or later", "type": "string" }, "visualization_identifiers": { "description": "GUID or name of visualizations on the Liveboard. If this parameter is\nnot defined, the API returns a report with all visualizations saved on a Liveboard.", "type": "array", "items": { "type": "string" } }, "transient_content": { "description": "Transient content of the Liveboard.", "type": "string" }, "file_format": { "description": "Export file format.", "default": "PDF", "type": "string", "enum": [ "PDF", "PNG", "CSV", "XLSX" ] }, "runtime_filter": { "description": "JSON object with representing filter condition to apply filters at runtime. For example, {\"col1\": \"region\", \"op1\": \"EQ\", \"val1\": \"northeast\" }. You can add multiple keys by incrementing the number at the end, for example, col2, op2, val2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_filters).", "type": "object" }, "override_filters": { "description": "Applied to the liveboard and overrides any filters already applied on the same columns in liveboard.\nFollowing example illustrate different kinds of filters:\n{\n \"override_filters\": [\n {\n \"column_name\": \"Color\",\n \"generic_filter\": {\n \"op\": \"IN\",\n \"values\": [\n \"almond\",\n \"turquoise\"\n ]\n },\n \"negate\": false\n },\n {\n \"column_name\": \"Commit Date\",\n \"date_filter\": {\n \"datePeriod\": \"HOUR\",\n \"number\": 3,\n \"type\": \"LAST_N_PERIOD\",\n \"op\": \"EQ\"\n }\n },\n {\n \"column_name\": \"Sales\",\n \"generic_filter\": {\n \"op\": \"BW_INC\",\n \"values\": [\n \"100000\",\n \"70000\"\n ]\n },\n \"negate\": true\n }\n ]\n}", "type": "object" }, "runtime_sort": { "description": "JSON string representing runtime sort. For example, {\"sortCol1\": \"region\", \"asc1\" : true}. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_sort).", "type": "object" }, "pdf_options": { "description": "Options for PDF export.", "allOf": [ { "$ref": "#/components/schemas/PdfOptionsInput" } ] }, "png_options": { "description": "Options for PNG export.", "allOf": [ { "$ref": "#/components/schemas/PngOptionsInput" } ] }, "runtime_param_override": { "description": "JSON object for setting values of parameters at runtime. For example, {\"param1\": \"Double List Param\", \"paramVal1\": 0.5}. You can add multiple keys by incrementing the number at the end, for example, param2, paramVal2. For more information, see [API Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_parameters).", "type": "object" }, "regional_settings": { "description": "Options for specific region specific overrides to support date/number/string/currency formatting.", "allOf": [ { "$ref": "#/components/schemas/RegionalSettingsInput" } ] } }, "required": [ "metadata_identifier" ] }, "CreateRoleRequest": { "type": "object", "properties": { "name": { "description": "Unique name of the Role.", "type": "string" }, "description": { "description": "Description of the Role.", "type": "string" }, "privileges": { "description": "Privileges granted to the Role. See [Documentation](https://developers.thoughtspot.com/docs/rbac#_role_categories_and_privileges)for supported roles privileges. Note: AUTHORING is a no-op — always inherited via ALL_GROUP, assigning it has no effect.", "type": "array", "items": { "type": "string", "enum": [ "USERDATAUPLOADING", "DATADOWNLOADING", "DATAMANAGEMENT", "SHAREWITHALL", "JOBSCHEDULING", "A3ANALYSIS", "BYPASSRLS", "DISABLE_PINBOARD_CREATION", "DEVELOPER", "APPLICATION_ADMINISTRATION", "USER_ADMINISTRATION", "GROUP_ADMINISTRATION", "SYSTEM_INFO_ADMINISTRATION", "SYNCMANAGEMENT", "ORG_ADMINISTRATION", "ROLE_ADMINISTRATION", "AUTHENTICATION_ADMINISTRATION", "BILLING_INFO_ADMINISTRATION", "CONTROL_TRUSTED_AUTH", "TAGMANAGEMENT", "LIVEBOARD_VERIFIER", "CAN_MANAGE_CUSTOM_CALENDAR", "CAN_CREATE_OR_EDIT_CONNECTIONS", "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", "CAN_MANAGE_VERSION_CONTROL", "THIRDPARTY_ANALYSIS", "CAN_CREATE_CATALOG", "ALLOW_NON_EMBED_FULL_APP_ACCESS", "CAN_ACCESS_ANALYST_STUDIO", "CAN_MANAGE_ANALYST_STUDIO", "PREVIEW_DOCUMENT_SEARCH", "CAN_MANAGE_VARIABLES", "CAN_MODIFY_FOLDERS", "CAN_VIEW_FOLDERS", "CAN_MANAGE_AGENTSPOT", "CAN_ACCESS_AGENTSPOT", "CAN_SETUP_VERSION_CONTROL", "PREVIEW_THOUGHTSPOT_SAGE", "CAN_MANAGE_WEBHOOKS", "CAN_DOWNLOAD_VISUALS", "CAN_DOWNLOAD_DETAILED_DATA", "CAN_USE_SPOTTER", "CAN_MANAGE_SPOTTER", "CAN_CREATE_LIVEBOARD", "CAN_CREATE_ANSWERS", "CAN_ANALYZE_DATA", "CAN_ADMINISTER_SCHEDULES", "CAN_CREATE_KPI_ALERTS" ] } }, "read_only": { "description": "
Version: 10.5.0.cl or later
\n\nIndicates whether the role is read only. A readonly role can neither be updated nor deleted.", "default": false, "type": "boolean", "nullable": true } }, "required": [ "name" ] }, "SearchRolesRequest": { "type": "object", "properties": { "role_identifiers": { "description": "unique ID or name of the Roles", "type": "array", "items": { "type": "string" } }, "org_identifiers": { "description": "Unique Id or name of the Organisation", "type": "array", "items": { "type": "string" } }, "group_identifiers": { "description": "Unique Id or name of the User Group", "type": "array", "items": { "type": "string" } }, "privileges": { "description": "Privileges assigned to the Role. See [Documentation](https://developers.thoughtspot.com/docs/rbac#_role_categories_and_privileges)for supported roles privileges.", "type": "array", "items": { "type": "string", "enum": [ "UNKNOWN", "ADMINISTRATION", "AUTHORING", "USERDATAUPLOADING", "DATADOWNLOADING", "USERMANAGEMENT", "SECURITYMANAGEMENT", "LOGICALMODELING", "DATAMANAGEMENT", "TAGMANAGEMENT", "SHAREWITHALL", "SYSTEMMANAGEMENT", "JOBSCHEDULING", "A3ANALYSIS", "EXPERIMENTALFEATUREPRIVILEGE", "BYPASSRLS", "RANALYSIS", "DISABLE_PINBOARD_CREATION", "DEVELOPER", "APPLICATION_ADMINISTRATION", "USER_ADMINISTRATION", "GROUP_ADMINISTRATION", "BACKUP_ADMINISTRATION", "SYSTEM_INFO_ADMINISTRATION", "ENABLESPOTAPPCREATION", "SYNCMANAGEMENT", "ORG_ADMINISTRATION", "ROLE_ADMINISTRATION", "AUTHENTICATION_ADMINISTRATION", "BILLING_INFO_ADMINISTRATION", "PREVIEW_THOUGHTSPOT_SAGE", "LIVEBOARD_VERIFIER", "CAN_MANAGE_CUSTOM_CALENDAR", "CAN_CREATE_OR_EDIT_CONNECTIONS", "CAN_CONFIGURE_CONNECTIONS", "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", "CAN_MANAGE_VERSION_CONTROL", "THIRDPARTY_ANALYSIS", "CONTROL_TRUSTED_AUTH", "CAN_CREATE_CATALOG", "ALLOW_NON_EMBED_FULL_APP_ACCESS", "CAN_ACCESS_ANALYST_STUDIO", "CAN_MANAGE_ANALYST_STUDIO", "CAN_VIEW_FOLDERS", "CAN_MODIDY_FOLDERS", "CAN_MANAGE_VARIABLES", "CAN_MANAGE_AGENTSPOT", "CAN_ACCESS_AGENTSPOT", "PREVIEW_DOCUMENT_SEARCH", "CAN_SETUP_VERSION_CONTROL", "CAN_MANAGE_WEBHOOKS", "CAN_DOWNLOAD_VISUALS", "CAN_DOWNLOAD_DETAILED_DATA", "CAN_USE_SPOTTER", "CAN_MANAGE_SPOTTER", "CAN_CREATE_LIVEBOARD", "CAN_CREATE_ANSWERS", "CAN_ANALYZE_DATA", "CAN_ADMINISTER_SCHEDULES", "CAN_CREATE_KPI_ALERTS" ] } }, "deprecated": { "description": "Indicates whether the Role is deprecated.", "type": "boolean", "deprecated": true, "nullable": true }, "external": { "description": "Indicates whether the Role is external", "type": "boolean", "deprecated": true, "nullable": true }, "shared_via_connection": { "description": "Indicates whether the Role is shared via connection", "type": "boolean", "deprecated": true, "nullable": true }, "permissions": { "description": "Permission details of the Role", "type": "array", "items": { "type": "string", "enum": [ "READ_ONLY", "MODIFY", "NO_ACCESS" ] }, "deprecated": true } } }, "UpdateRoleRequest": { "type": "object", "properties": { "name": { "description": "Name of the Role.", "type": "string" }, "description": { "description": "Description of the Role.", "type": "string" }, "privileges": { "description": "Privileges granted to the role. See [Documentation](https://developers.thoughtspot.com/docs/rbac#_role_categories_and_privileges)for supported roles privileges. Note: AUTHORING is a no-op — always inherited via ALL_GROUP, assigning it has no effect.", "type": "array", "items": { "type": "string", "enum": [ "USERDATAUPLOADING", "DATADOWNLOADING", "DATAMANAGEMENT", "SHAREWITHALL", "JOBSCHEDULING", "A3ANALYSIS", "BYPASSRLS", "DISABLE_PINBOARD_CREATION", "DEVELOPER", "APPLICATION_ADMINISTRATION", "USER_ADMINISTRATION", "GROUP_ADMINISTRATION", "SYSTEM_INFO_ADMINISTRATION", "SYNCMANAGEMENT", "ORG_ADMINISTRATION", "ROLE_ADMINISTRATION", "AUTHENTICATION_ADMINISTRATION", "BILLING_INFO_ADMINISTRATION", "CONTROL_TRUSTED_AUTH", "TAGMANAGEMENT", "LIVEBOARD_VERIFIER", "CAN_MANAGE_CUSTOM_CALENDAR", "CAN_CREATE_OR_EDIT_CONNECTIONS", "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", "CAN_MANAGE_VERSION_CONTROL", "THIRDPARTY_ANALYSIS", "CAN_CREATE_CATALOG", "CAN_ACCESS_ANALYST_STUDIO", "CAN_MANAGE_ANALYST_STUDIO", "CAN_MODIFY_FOLDERS", "CAN_MANAGE_VARIABLES", "CAN_VIEW_FOLDERS", "CAN_MANAGE_AGENTSPOT", "CAN_ACCESS_AGENTSPOT", "PREVIEW_DOCUMENT_SEARCH", "PREVIEW_THOUGHTSPOT_SAGE", "CAN_MANAGE_WEBHOOKS", "CAN_DOWNLOAD_VISUALS", "CAN_DOWNLOAD_DETAILED_DATA", "CAN_USE_SPOTTER", "CAN_MANAGE_SPOTTER", "CAN_CREATE_LIVEBOARD", "CAN_CREATE_ANSWERS", "CAN_ANALYZE_DATA", "CAN_ADMINISTER_SCHEDULES", "CAN_CREATE_KPI_ALERTS" ] } } }, "required": [ "name" ] }, "CreateScheduleRequest": { "type": "object", "properties": { "name": { "description": "Name of the scheduled job.", "type": "string" }, "description": { "description": "Description of the job.", "type": "string" }, "metadata_type": { "description": "Type of the metadata object.", "type": "string", "enum": [ "LIVEBOARD" ] }, "metadata_identifier": { "description": "Unique ID or name of the metadata object.", "type": "string" }, "file_format": { "description": "Export file format.", "default": "PDF", "type": "string", "enum": [ "CSV", "PDF", "XLSX" ] }, "liveboard_options": { "description": "Options to specify details of Liveboard.", "allOf": [ { "$ref": "#/components/schemas/LiveboardOptionsInput" } ] }, "pdf_options": { "description": "PDF layout and orientation settings. Applicable only if the `file_format` is specified as `PDF`.", "allOf": [ { "$ref": "#/components/schemas/SchedulesPdfOptionsInput" } ] }, "time_zone": { "description": "Time zone", "default": "America/Los_Angeles", "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT0", "Greenwich", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROK", "Singapore", "SystemV/AST4", "SystemV/AST4ADT", "SystemV/CST6", "SystemV/CST6CDT", "SystemV/EST5", "SystemV/EST5EDT", "SystemV/HST10", "SystemV/MST7", "SystemV/MST7MDT", "SystemV/PST8", "SystemV/PST8PDT", "SystemV/YST9", "SystemV/YST9YDT", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu", "EST", "HST", "MST", "ACT", "AET", "AGT", "ART", "AST", "BET", "BST", "CAT", "CNT", "CST", "CTT", "EAT", "ECT", "IET", "IST", "JST", "MIT", "NET", "NST", "PLT", "PNT", "PRT", "PST", "SST", "VST" ] }, "frequency": { "description": "Frequency settings for the scheduled job.", "allOf": [ { "$ref": "#/components/schemas/FrequencyInput" } ] }, "recipient_details": { "description": "Recipients of the scheduled job notifications. Add the GUID or name of the ThoughtSpot users or groups as recipients in the `principals` array. If a recipient is not a ThoughtSpot user, specify email address.", "allOf": [ { "$ref": "#/components/schemas/RecipientDetailsInput" } ] }, "personalised_view_id": { "description": "Personalised view id of the liveboard to be scheduled.", "type": "string" } }, "required": [ "name", "description", "metadata_type", "metadata_identifier", "time_zone", "recipient_details" ] }, "SearchSchedulesRequest": { "type": "object", "properties": { "metadata": { "description": "Metadata objects associated with the scheduled jobs.", "type": "array", "items": { "$ref": "#/components/schemas/MetadataInput" } }, "record_offset": { "description": "The starting record number from where the records should be included.", "type": "integer", "format": "int32" }, "record_size": { "description": "The number of records that should be included.", "type": "integer", "format": "int32" }, "sort_options": { "description": "Sort options.", "allOf": [ { "$ref": "#/components/schemas/SortingOptions" } ] }, "history_runs_options": { "description": "Options while fetching history runs for the schedule.", "allOf": [ { "$ref": "#/components/schemas/ScheduleHistoryRunsOptionsInput" } ] }, "schedule_identifiers": { "description": "unique ID or name of the Schedule", "type": "array", "items": { "type": "string" } } } }, "UpdateScheduleRequest": { "type": "object", "properties": { "name": { "description": "Name of the scheduled job.", "type": "string" }, "description": { "description": "Description of the scheduled job.", "type": "string" }, "metadata_type": { "description": "Type of metadata object.", "type": "string", "enum": [ "LIVEBOARD" ] }, "metadata_identifier": { "description": "Unique ID or name of the metadata object.", "type": "string" }, "file_format": { "description": "Export file format.", "type": "string", "enum": [ "CSV", "PDF", "XLSX" ] }, "liveboard_options": { "description": "Options to specify the details of a Liveboard.", "allOf": [ { "$ref": "#/components/schemas/LiveboardOptionsInput" } ] }, "pdf_options": { "description": "Options for PDF export.", "allOf": [ { "$ref": "#/components/schemas/SchedulesPdfOptionsInput" } ] }, "time_zone": { "description": "Time zone", "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT0", "Greenwich", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROK", "Singapore", "SystemV/AST4", "SystemV/AST4ADT", "SystemV/CST6", "SystemV/CST6CDT", "SystemV/EST5", "SystemV/EST5EDT", "SystemV/HST10", "SystemV/MST7", "SystemV/MST7MDT", "SystemV/PST8", "SystemV/PST8PDT", "SystemV/YST9", "SystemV/YST9YDT", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu", "EST", "HST", "MST", "ACT", "AET", "AGT", "ART", "AST", "BET", "BST", "CAT", "CNT", "CST", "CTT", "EAT", "ECT", "IET", "IST", "JST", "MIT", "NET", "NST", "PLT", "PNT", "PRT", "PST", "SST", "VST" ] }, "frequency": { "description": "Frequency of the scheduled job run.", "allOf": [ { "$ref": "#/components/schemas/FrequencyInput" } ] }, "recipient_details": { "description": "Recipients of the scheduled job notifications. You can add the ID or name of the ThoughtSpot users or groups as recipients in the `principals` array. If a recipient is not a ThoughtSpot user, specify email address.", "allOf": [ { "$ref": "#/components/schemas/RecipientDetailsInput" } ] }, "status": { "description": "Status of the schedule", "type": "string", "enum": [ "ACTIVE", "PAUSE" ] }, "personalised_view_id": { "description": "Personalised view id of the liveboard to be scheduled.", "type": "string" } } }, "AssignChangeAuthorRequest": { "type": "object", "properties": { "metadata": { "description": "GUID or name of the metadata object.", "type": "array", "items": { "$ref": "#/components/schemas/AuthorMetadataTypeInput" } }, "user_identifier": { "description": "GUID or name of the user who you want to assign as the author.", "type": "string" }, "current_owner_identifier": { "description": "GUID or name of the current author. When defined, the metadata objects\nauthored by the specified owner are filtered for the API operation.", "type": "string" } }, "required": [ "metadata", "user_identifier" ] }, "FetchColumnSecurityRulesRequest": { "type": "object", "properties": { "tables": { "description": "Array of table identifier objects for which to fetch column security rules", "type": "array", "items": { "$ref": "#/components/schemas/ColumnSecurityRuleTableInput" } } }, "required": [ "tables" ] }, "FetchObjectPrivilegesRequest": { "type": "object", "properties": { "metadata": { "description": "Metadata objects for which you want to fetch object privileges. For now only LOGICAL_TABLE is supported. It may be extended to other metadata types in the future.", "type": "array", "items": { "$ref": "#/components/schemas/ObjectPrivilegesMetadataInput" } }, "principals": { "description": "User or group objects for which you want to fetch object privileges.\nIf not specified, the API returns all users and groups that\nhave object privileges on the specified metadata objects.", "type": "array", "items": { "$ref": "#/components/schemas/PrincipalsInput" } }, "record_offset": { "description": "The starting record number from where the records should be included for each metadata type.", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "The number of records that should be included for each metadata type.", "default": 20, "type": "integer", "format": "int32" } }, "required": [ "metadata" ] }, "FetchPermissionsOfPrincipalsRequest": { "type": "object", "properties": { "principals": { "description": "GUID or name of the user or group.", "type": "array", "items": { "$ref": "#/components/schemas/PrincipalsInput" } }, "metadata": { "description": "Metadata objects for which you want to fetch permission details.\nIf not specified, the API returns permission details for all\nmetadata objects that the specified users and groups can access.", "type": "array", "items": { "$ref": "#/components/schemas/PermissionsMetadataTypeInput" } }, "record_offset": { "description": "The starting record number from where the records should be included for each metadata type.", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "The number of records that should be included for each metadata type.", "default": -1, "type": "integer", "format": "int32" }, "default_metadata_type": { "description": "When no metadata objects input is passed, metadata objects of this type are fetched.", "type": "string", "enum": [ "ALL", "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "LOGICAL_COLUMN", "CONNECTION", "COLLECTION" ] } }, "required": [ "principals" ] }, "FetchPermissionsOnMetadataRequest": { "type": "object", "properties": { "metadata": { "description": "GUID or name of the metadata object.", "type": "array", "items": { "$ref": "#/components/schemas/PermissionsMetadataTypeInput" } }, "principals": { "description": "User or group objects for which you want to fetch permissions.\nIf not specified, the API returns all users and groups that\ncan access the specified metadata objects.", "type": "array", "items": { "$ref": "#/components/schemas/PrincipalsInput" } }, "include_dependent_objects": { "description": "Indicates whether to fetch permissions of dependent metadata objects.", "default": false, "type": "boolean", "nullable": true }, "record_offset": { "description": "The starting record number from where the records should be included for each metadata type.", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "The number of records that should be included for each metadata type.", "default": -1, "type": "integer", "format": "int32" }, "permission_type": { "description": "
Version: 10.3.0.cl or later
\n\nSpecifies the type of permission. Valid values are:\n EFFECTIVE - If the user permission to the metadata objects is granted by the privileges assigned to the groups to which they belong.\n DEFINED - If a user or user group received access to metadata objects via object sharing by another user.", "type": "string" } }, "required": [ "metadata" ] }, "ManageObjectPrivilegeRequest": { "type": "object", "properties": { "operation": { "description": "Operation to perform to manage object privileges. Available operations are: `ADD`, `REMOVE`.", "type": "string", "enum": [ "ADD", "REMOVE" ] }, "metadata_type": { "description": "Type of metadata objects on which you want to perform the operation. For now only LOGICAL_TABLE is supported. It may be extended to other metadata types in the future.", "type": "string", "enum": [ "LOGICAL_TABLE" ] }, "object_privilege_types": { "description": "List of object privilege types on which you want to perform the operation.", "type": "array", "items": { "type": "string", "enum": [ "SPOTTER_COACHING_PRIVILEGE" ] } }, "metadata_identifiers": { "description": "List of metadata identifiers (GUID or name) on which you want to perform the operation.", "type": "array", "items": { "type": "string" } }, "principals": { "description": "User or group objects (GUID or name) to which you want to apply the given operation and given object privileges.", "type": "array", "items": { "$ref": "#/components/schemas/PrincipalsInput" } } }, "required": [ "operation", "metadata_type", "object_privilege_types", "metadata_identifiers", "principals" ] }, "PublishMetadataRequest": { "type": "object", "properties": { "metadata": { "description": "Metadata objects to be published.", "type": "array", "items": { "$ref": "#/components/schemas/PublishMetadataListItem" } }, "org_identifiers": { "description": "Unique ID or name of orgs to which metadata objects should be published.", "type": "array", "items": { "type": "string" } }, "skip_validation": { "description": "Skip parameterization validation. By default publishing requires an underlying\nLOGICAL_TABLE or DATA_SOURCE to carry a template variable with a value for every\ntarget org, so each org resolves its own data. Without parameterization every target\norg reads the owner org's data through the owner org's connection. Set this to true\nonly when that is intended.", "type": "boolean", "nullable": true } }, "required": [ "metadata", "org_identifiers" ] }, "ShareMetadataRequest": { "type": "object", "properties": { "metadata_type": { "description": "Type of metadata. Required if identifier in metadata_identifies is a name.\n1. Liveboard\n2. Answers\n3. LOGICAL_TABLE for any data object such as table, worksheet or view.\n4. LOGICAL_COLUMN\n5. Connection\n6. Collection", "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "LOGICAL_COLUMN", "CONNECTION", "COLLECTION" ] }, "metadata_identifiers": { "description": "Unique ID or name of metadata objects. Note: All the names should belong to same metadata_type", "type": "array", "items": { "type": "string" } }, "metadata": { "description": "Metadata details for sharing objects.", "type": "array", "items": { "$ref": "#/components/schemas/ShareMetadataTypeInput" } }, "permissions": { "description": "Permission details for sharing the objects.", "type": "array", "items": { "$ref": "#/components/schemas/SharePermissionsInput" } }, "visualization_identifiers": { "description": "Options to specify details of Liveboard. First Liveboard encountered in payload is considered to be the corresponding Liveboard.", "type": "array", "items": { "type": "string" } }, "emails": { "description": "Email IDs to which notifications will be sent.", "default": [], "type": "array", "items": { "type": "string" } }, "message": { "description": "Message to be included in notification.", "type": "string" }, "enable_custom_url": { "description": "Sends object URLs in the customized format in email notifications.", "default": false, "type": "boolean", "nullable": true }, "notify_on_share": { "description": "Flag to notify user when any object is shared.", "default": true, "type": "boolean", "nullable": true }, "has_lenient_discoverability": { "description": "Flag to make the object discoverable.", "default": false, "type": "boolean", "nullable": true } }, "required": [ "permissions", "message" ] }, "UnpublishMetadataRequest": { "type": "object", "properties": { "force": { "description": "Force unpublishes the object. This will break all the dependent objects in the unpublished orgs.", "type": "boolean", "nullable": true }, "include_dependencies": { "description": "Should we unpublish all the dependencies for the objects specified.\nThe dependencies will be unpublished if no other published object is using it.", "type": "boolean" }, "metadata": { "description": "Metadata objects.", "type": "array", "items": { "$ref": "#/components/schemas/PublishMetadataListItem" } }, "org_identifiers": { "description": "Unique ID or name of orgs.", "type": "array", "items": { "type": "string" } } }, "required": [ "include_dependencies", "metadata", "org_identifiers" ] }, "UpdateColumnSecurityRulesRequest": { "type": "object", "properties": { "identifier": { "description": "GUID or name of the table for which we want to create column security rules", "type": "string" }, "obj_identifier": { "description": "The object ID of the table", "type": "string" }, "clear_csr": { "description": "If true, then all the secured columns will be marked as unprotected, and all the group associations will be removed", "type": "boolean", "nullable": true }, "column_security_rules": { "description": "Array where each object defines the security rule for a specific column", "type": "array", "items": { "$ref": "#/components/schemas/ColumnSecurityRuleUpdate" } } }, "required": [ "column_security_rules" ] }, "CreateSemanticIntegrationRequest": { "type": "object", "properties": { "connection_identifier": { "description": "ID or name of the CDW connection.", "type": "string" }, "name": { "description": "Name of the semantic integration. Must be unique.", "type": "string" }, "database_name": { "description": "Database name in the CDW.", "type": "string" }, "schema_name": { "description": "Schema name in the CDW.", "type": "string" }, "semantic_view_name": { "description": "Semantic view name in the CDW.", "type": "string" }, "type": { "description": "CDW connector type.", "type": "string", "enum": [ "RDBMS_SNOWFLAKE", "RDBMS_DATABRICKS" ] }, "description": { "description": "Optional description of the semantic integration.", "type": "string" } }, "required": [ "connection_identifier", "name", "database_name", "schema_name", "semantic_view_name", "type" ] }, "SearchSemanticIntegrationsRequest": { "type": "object", "properties": { "sort_options": { "description": "Sort options for the search results.", "allOf": [ { "$ref": "#/components/schemas/SemanticIntegrationSortOptions" } ] }, "record_offset": { "description": "Number of records to skip for pagination. Minimum value is 0.", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "Maximum number of records to return. Use 0 to return all records (no pagination).", "default": 10, "type": "integer", "format": "int32" }, "pattern": { "description": "Name filter substring to narrow search results.", "type": "string" }, "author_identifiers": { "description": "Filter by author IDs or names who created the integrations.", "type": "array", "items": { "type": "string" } }, "connection_identifiers": { "description": "Filter by connection IDs or names associated with the integrations.", "type": "array", "items": { "type": "string" } } } }, "DeleteStyleFontsRequest": { "type": "object", "properties": { "scope": { "description": "Scope of the font library to delete from. CLUSTER deletes from the\ncluster-level library. ORG deletes from the authenticated user's org\nlibrary. Defaults to ORG if omitted.", "default": "ORG", "type": "string", "enum": [ "CLUSTER", "ORG" ] }, "font_identifiers": { "description": "UUIDs or names of the fonts to delete. At least one identifier is\nrequired.", "type": "array", "items": { "type": "string" } }, "dry_run": { "description": "When true, returns affected assignments without applying the deletion.\nUse this to preview the impact before committing. Defaults to true if\nomitted.", "default": true, "type": "boolean", "nullable": true } }, "required": [ "font_identifiers" ] }, "ExportStyleLogosRequest": { "type": "object", "properties": { "scope": { "description": "Scope of the logos to export. CLUSTER exports cluster-level logos. ORG\nexports logos for the authenticated user's org, falling back to cluster\nor defaults if no custom logo is set. Defaults to ORG if\nomitted.", "default": "ORG", "type": "string", "enum": [ "CLUSTER", "ORG" ] } } }, "SearchStyleCustomizationsRequest": { "type": "object", "properties": { "scope": { "description": "Scope of the style preferences to retrieve. CLUSTER returns cluster-level\ndefaults. ORG returns preferences for the authenticated user's org, which\nmay override cluster defaults. If not specified, returns both cluster and\norg preferences based on user privileges.", "type": "string", "enum": [ "CLUSTER", "ORG" ] } } }, "SearchStyleFontsRequest": { "type": "object", "properties": { "scope": { "description": "Scope of the font library to search. CLUSTER searches the cluster-level\nlibrary. ORG searches the authenticated user's org library. Returns both Cluster and Org\nlevel font if omitted.", "type": "string", "enum": [ "CLUSTER", "ORG" ] }, "font_identifier": { "description": "Filter by UUID or name of a specific font.", "type": "string" }, "name_pattern": { "description": "Filter by font display name. Supports partial, case-insensitive matching.", "type": "string" }, "include_font_assignments": { "description": "When true, includes visualization areas this font is assigned to in the\nresponse. Defaults to false if omitted.", "default": false, "type": "boolean", "nullable": true } } }, "UpdateStyleFontRequest": { "type": "object", "properties": { "scope": { "description": "Scope of the font library containing this font. CLUSTER targets the\ncluster-level library. ORG targets the authenticated user's org library.\nDefaults to ORG if omitted.", "default": "ORG", "type": "string", "enum": [ "CLUSTER", "ORG" ] }, "name": { "description": "New display name for the font.", "type": "string" }, "weight": { "description": "New weight for the font. Supported values: NORMAL, LIGHT, BOLD.", "type": "string", "enum": [ "NORMAL", "LIGHT", "BOLD" ] }, "style": { "description": "New style for the font. Supported values: NORMAL, ITALIC, OBLIQUE.", "type": "string", "enum": [ "NORMAL", "ITALIC", "OBLIQUE" ] }, "color": { "description": "New color for the font as a 6-digit hex string (e.g. \"#333333\"). Returns\nan error if the value is malformed.", "type": "string" } } }, "ConfigureCommunicationChannelPreferencesRequest": { "type": "object", "properties": { "cluster_preferences": { "description": "Cluster-level default configurations.", "type": "array", "items": { "$ref": "#/components/schemas/EventChannelConfigInput" } }, "org_preferences": { "description": "Org-specific configurations.", "type": "array", "items": { "$ref": "#/components/schemas/OrgChannelConfigInput" } } } }, "ConfigureSecuritySettingsRequest": { "type": "object", "properties": { "cluster_preferences": { "description": "Cluster-level security preferences.", "allOf": [ { "$ref": "#/components/schemas/SecuritySettingsClusterPreferencesInput" } ] }, "org_preferences": { "description": "Org-level security preferences for the current org.", "type": "array", "items": { "$ref": "#/components/schemas/SecuritySettingsOrgPreferencesInput" } } } }, "SearchCommunicationChannelPreferencesRequest": { "type": "object", "properties": { "cluster_preferences": { "description": "Event types to search for in cluster-level preferences.", "type": "array", "items": { "type": "string", "enum": [ "LIVEBOARD_SCHEDULE" ] } }, "org_preferences": { "description": "Org-specific search criteria.", "type": "array", "items": { "$ref": "#/components/schemas/OrgPreferenceSearchCriteriaInput" } } } }, "SearchSecuritySettingsRequest": { "type": "object", "properties": { "scope": { "description": "Scope of security settings to retrieve. CLUSTER returns cluster-level settings,\nORG returns org-level settings for the current org.\nIf not specified, returns both cluster and org settings based on user privileges.", "type": "string", "enum": [ "CLUSTER", "ORG" ] } } }, "UpdateSystemConfigRequest": { "type": "object", "properties": { "configuration": { "description": "Configuration JSON with the key-value pair of configuration attributes to be updated.", "type": "object" } }, "required": [ "configuration" ] }, "ValidateCommunicationChannelRequest": { "type": "object", "properties": { "channel_type": { "description": "Type of communication channel to validate (e.g., WEBHOOK).", "type": "string", "enum": [ "WEBHOOK" ] }, "channel_identifier": { "description": "Unique identifier or name for the communication channel.", "type": "string" }, "event_type": { "description": "Event type to validate for this channel.", "type": "string", "enum": [ "LIVEBOARD_SCHEDULE" ] } }, "required": [ "channel_type", "channel_identifier", "event_type" ] }, "AssignTagRequest": { "type": "object", "properties": { "metadata": { "description": "Metadata objects.", "type": "array", "items": { "$ref": "#/components/schemas/TagMetadataTypeInput" } }, "tag_identifiers": { "description": "GUID or name of the tag.", "type": "array", "items": { "type": "string" } } }, "required": [ "metadata", "tag_identifiers" ] }, "CreateTagRequest": { "type": "object", "properties": { "name": { "description": "Name of the tag.", "type": "string" }, "color": { "description": "Hex color code to be assigned to the tag. For example, #ff78a9.", "type": "string" } }, "required": [ "name" ] }, "SearchTagsRequest": { "type": "object", "properties": { "tag_identifier": { "description": "Name or Id of the tag.", "type": "string" }, "name_pattern": { "description": "A pattern to match case-insensitive name of the Tag object.", "type": "string" }, "color": { "description": "Color of the tag.", "type": "string" } } }, "UnassignTagRequest": { "type": "object", "properties": { "metadata": { "description": "Metadata objects.", "type": "array", "items": { "$ref": "#/components/schemas/TagMetadataTypeInput" } }, "tag_identifiers": { "description": "GUID or name of the tag.", "type": "array", "items": { "type": "string" } } }, "required": [ "metadata", "tag_identifiers" ] }, "UpdateTagRequest": { "type": "object", "properties": { "name": { "description": "Name of the tag.", "type": "string" }, "color": { "description": "Hex color code to be assigned to the tag. For example, #ff78a9.", "type": "string" } } }, "ActivateUserRequest": { "type": "object", "properties": { "user_identifier": { "description": "Unique ID or name of the user.", "type": "string" }, "auth_token": { "description": "Auth token for the user.", "type": "string" }, "password": { "description": "New password for the user to access the account.", "type": "string" }, "properties": { "description": "Properties of the user.", "type": "string" } }, "required": [ "user_identifier", "auth_token", "password" ] }, "ChangeUserPasswordRequest": { "type": "object", "properties": { "current_password": { "description": "Current password of the user.", "type": "string" }, "new_password": { "description": "New password for the user.", "type": "string" }, "user_identifier": { "description": "GUID or name of the user.", "type": "string" } }, "required": [ "current_password", "new_password", "user_identifier" ] }, "CreateUserRequest": { "type": "object", "properties": { "name": { "description": "Name of the user. The username string must be unique.", "type": "string" }, "display_name": { "description": "A unique display name string for the user account, usually their first and last name", "type": "string" }, "password": { "description": "Password for the user account. For IAMv2 users, you must set this password if you do not want to trigger an activation email.", "type": "string" }, "email": { "description": "Email of the user account", "type": "string" }, "account_type": { "description": "Type of the account.", "default": "LOCAL_USER", "type": "string", "enum": [ "LOCAL_USER", "LDAP_USER", "SAML_USER", "OIDC_USER", "REMOTE_USER" ] }, "account_status": { "description": "Current status of the user account. The `SUSPENDED` user state indicates a transitional state applicable to IAMv2 users only.", "default": "ACTIVE", "type": "string", "enum": [ "ACTIVE", "INACTIVE", "EXPIRED", "LOCKED", "PENDING", "SUSPENDED" ] }, "org_identifiers": { "description": "List of Org IDs to which the user belongs.", "type": "array", "items": { "type": "string" } }, "group_identifiers": { "description": "GUIDs or names of the groups to which the newly created user belongs.", "type": "array", "items": { "type": "string" } }, "visibility": { "description": "Visibility of the users. When set to SHARABLE, the user is visible to other users and groups when they try to share an object.", "default": "SHARABLE", "type": "string", "enum": [ "SHARABLE", "NON_SHARABLE" ] }, "notify_on_share": { "description": "User preference for receiving email notifications when another ThoughtSpot\nuser shares a metadata object such as Answer, Liveboard, or Worksheet.", "default": true, "type": "boolean", "nullable": true }, "show_onboarding_experience": { "description": "The user preference for revisiting the onboarding experience.", "default": true, "type": "boolean", "nullable": true }, "onboarding_experience_completed": { "description": "flag to get the on-boarding experience is completed or not.", "default": false, "type": "boolean", "nullable": true }, "home_liveboard_identifier": { "description": "GUID of the Liveboard to set a default Liveboard for the user.\nThoughtSpot displays this Liveboard on the Home page when the user logs in.", "type": "string" }, "favorite_metadata": { "description": "Metadata objects to add to the user's favorites list.", "type": "array", "items": { "$ref": "#/components/schemas/FavoriteMetadataInput" } }, "preferred_locale": { "description": "Locale for the user. When setting this value, do not set use_browser_language\nto true, otherwise the browser's language setting will take precedence and the\npreferred_locale value will be ignored.", "type": "string", "enum": [ "en-CA", "en-GB", "en-US", "de-DE", "ja-JP", "zh-CN", "pt-BR", "fr-FR", "fr-CA", "es-US", "da-DK", "es-ES", "fi-FI", "sv-SE", "nb-NO", "pt-PT", "nl-NL", "it-IT", "ru-RU", "en-IN", "de-CH", "en-NZ", "es-MX", "en-AU", "zh-Hant", "ko-KR", "en-DE" ] }, "use_browser_language": { "description": "Flag to indicate whether to use the browser locale for the user in the UI.\nWhen set to true, the preferred_locale value is unset and the browser's\nlanguage setting takes precedence.
Version: 26.3.0.cl or later", "type": "boolean", "nullable": true }, "extended_properties": { "description": "Properties for the user", "type": "object" }, "extended_preferences": { "description": "Preferences for the user", "type": "object" }, "trigger_welcome_email": { "description": "Flag to indicate whether a welcome email should be sent to the user. This parameter applies only on clusters where IAMv2 is not enabled. If the flag details are not specified, then it defaults to true. However, a welcome email is sent only when welcome email notifications are enabled on the cluster and the user has a valid email address.", "type": "boolean", "nullable": true }, "trigger_activation_email": { "description": "Flag to indicate whether activation email should be sent to the user. Default value for IAMv2 users is set to true. Users must either set this to false, or enter a valid \npassword if they do not want to trigger an activation email.", "type": "boolean", "nullable": true } }, "required": [ "name", "display_name", "email" ] }, "DeactivateUserRequest": { "type": "object", "properties": { "user_identifier": { "description": "Unique ID or name of the user.", "type": "string" }, "base_url": { "description": "Base url of the cluster.", "type": "string" } }, "required": [ "user_identifier", "base_url" ] }, "ForceLogoutUsersRequest": { "type": "object", "properties": { "user_identifiers": { "description": "GUID or name of the users for force logging out their sessions.", "type": "array", "items": { "type": "string" } } } }, "ImportUsersRequest": { "type": "object", "properties": { "users": { "description": "List of users needs to be imported.", "type": "array", "items": { "$ref": "#/components/schemas/ImportUser" } }, "default_password": { "description": "The default password to assign to users if they do not have a password assigned in ThoughtSpot.", "type": "string" }, "dry_run": { "description": "If true, the API performs a test operation and returns user IDs whose data will be edited after the import.", "default": true, "type": "boolean", "nullable": true }, "delete_unspecified_users": { "description": "If set to true, removes the users that are not specified in the API request.", "default": false, "type": "boolean", "nullable": true } }, "required": [ "users" ] }, "ResetUserPasswordRequest": { "type": "object", "properties": { "new_password": { "description": "New password for the user.", "type": "string" }, "user_identifier": { "description": "GUID or name of the user.", "type": "string" } }, "required": [ "new_password", "user_identifier" ] }, "SearchUsersRequest": { "type": "object", "properties": { "user_identifier": { "description": "GUID / name of the user to search", "type": "string" }, "display_name": { "description": "A unique display name string for the user account, usually their first and last name", "type": "string" }, "name_pattern": { "description": "A pattern to match case-insensitive name of the User object.", "type": "string" }, "visibility": { "description": "Visibility of the user", "type": "string", "enum": [ "SHARABLE", "NON_SHARABLE" ] }, "email": { "description": "Email of the user account", "type": "string" }, "group_identifiers": { "description": "GUID or name of the group to which the user belongs", "type": "array", "items": { "type": "string" } }, "privileges": { "description": "Privileges assigned to the user", "type": "array", "items": { "type": "string", "enum": [ "ADMINISTRATION", "AUTHORING", "USERDATAUPLOADING", "DATADOWNLOADING", "USERMANAGEMENT", "DATAMANAGEMENT", "SHAREWITHALL", "JOBSCHEDULING", "A3ANALYSIS", "EXPERIMENTALFEATUREPRIVILEGE", "BYPASSRLS", "RANALYSIS", "DEVELOPER", "USER_ADMINISTRATION", "GROUP_ADMINISTRATION", "SYNCMANAGEMENT", "CAN_CREATE_CATALOG", "DISABLE_PINBOARD_CREATION", "LIVEBOARD_VERIFIER", "PREVIEW_THOUGHTSPOT_SAGE", "APPLICATION_ADMINISTRATION", "SYSTEM_INFO_ADMINISTRATION", "ORG_ADMINISTRATION", "ROLE_ADMINISTRATION", "AUTHENTICATION_ADMINISTRATION", "BILLING_INFO_ADMINISTRATION", "CAN_MANAGE_CUSTOM_CALENDAR", "CAN_CREATE_OR_EDIT_CONNECTIONS", "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", "CAN_MANAGE_VERSION_CONTROL", "THIRDPARTY_ANALYSIS", "ALLOW_NON_EMBED_FULL_APP_ACCESS", "CAN_ACCESS_ANALYST_STUDIO", "CAN_MANAGE_ANALYST_STUDIO", "PREVIEW_DOCUMENT_SEARCH", "CAN_MODIFY_FOLDERS", "CAN_MANAGE_VARIABLES", "CAN_VIEW_FOLDERS", "CAN_MANAGE_AGENTSPOT", "CAN_ACCESS_AGENTSPOT", "CAN_SETUP_VERSION_CONTROL", "CAN_MANAGE_WEBHOOKS", "CAN_DOWNLOAD_VISUALS", "CAN_DOWNLOAD_DETAILED_DATA", "CAN_USE_SPOTTER", "CAN_MANAGE_SPOTTER", "CAN_CREATE_LIVEBOARD", "CAN_CREATE_ANSWERS", "CAN_ANALYZE_DATA", "CAN_ADMINISTER_SCHEDULES", "CAN_CREATE_KPI_ALERTS" ] } }, "account_type": { "description": "Type of the account", "type": "string", "enum": [ "LOCAL_USER", "LDAP_USER", "SAML_USER", "OIDC_USER", "REMOTE_USER" ] }, "account_status": { "description": "Current status of the user account.", "type": "string", "enum": [ "ACTIVE", "INACTIVE", "EXPIRED", "LOCKED", "PENDING", "SUSPENDED" ] }, "notify_on_share": { "description": "User preference for receiving email notifications when another ThoughtSpot user\nshares a metadata object such as Answer, Liveboard, or Worksheet.", "type": "boolean", "nullable": true }, "show_onboarding_experience": { "description": "The user preference for revisiting the onboarding experience", "type": "boolean", "nullable": true }, "onboarding_experience_completed": { "description": "Indicates if the user has completed the onboarding walkthrough", "type": "boolean", "nullable": true }, "org_identifiers": { "description": "IDs or names of the Orgs to which the user belongs", "type": "array", "items": { "type": "string" } }, "home_liveboard_identifier": { "description": "Unique ID or name of the user's home Liveboard.", "type": "string" }, "favorite_metadata": { "description": "Metadata objects which are assigned as favorites of the user.", "type": "array", "items": { "$ref": "#/components/schemas/FavoriteMetadataInput" } }, "record_offset": { "description": "The starting record number from where the records should be included.", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "The number of records that should be included.", "default": 10, "type": "integer", "format": "int32" }, "sort_options": { "description": "Sort options.", "allOf": [ { "$ref": "#/components/schemas/SortOptions" } ] }, "role_identifiers": { "description": "Filters by the role assigned to the user.", "type": "array", "items": { "type": "string" } }, "include_favorite_metadata": { "description": "Indicates if the user's favorite objects should be displayed.", "default": false, "type": "boolean", "nullable": true }, "include_variable_values": { "description": "Indicates if the user's formula variable values should be included in the response.", "default": false, "type": "boolean", "nullable": true } } }, "UpdateUserRequest": { "type": "object", "properties": { "name": { "description": "Name of the user. The username string must be unique.", "type": "string" }, "display_name": { "description": "A unique display name string for the user account, usually their first and last name", "type": "string" }, "visibility": { "description": "Visibility of the users. When set to SHARABLE, the user is visible to other users and groups when they try to share an object.", "type": "string", "enum": [ "SHARABLE", "NON_SHARABLE" ] }, "email": { "description": "Email of the user account", "type": "string" }, "account_status": { "description": "Current status of the user account. The `SUSPENDED` user state indicates a transitional state applicable to IAMv2 users only.", "type": "string", "enum": [ "ACTIVE", "INACTIVE", "EXPIRED", "LOCKED", "PENDING", "SUSPENDED" ] }, "notify_on_share": { "description": "User preference for receiving email notifications when another ThoughtSpot user\nshares a metadata object such as Answer, Liveboard, or Worksheet.", "type": "boolean", "nullable": true }, "show_onboarding_experience": { "description": "The user preference for revisiting the onboarding experience.", "type": "boolean", "nullable": true }, "onboarding_experience_completed": { "description": "Indicates if the user has completed the onboarding and allows turning off the onboarding walkthrough.", "type": "boolean", "nullable": true }, "account_type": { "description": "Type of the account.", "type": "string", "enum": [ "LOCAL_USER", "LDAP_USER", "SAML_USER", "OIDC_USER", "REMOTE_USER" ] }, "group_identifiers": { "description": "GUIDs or names of the groups.", "type": "array", "items": { "type": "string" } }, "home_liveboard_identifier": { "description": "GUID of the Liveboard to set a default Liveboard for the user. ThoughtSpot displays\nthis Liveboard on the Home page when the user logs in.", "type": "string" }, "favorite_metadata": { "description": "Metadata objects to add to the user's favorites list.", "type": "array", "items": { "$ref": "#/components/schemas/FavoriteMetadataInput" } }, "org_identifiers": { "description": "IDs of the Orgs.", "type": "array", "items": { "type": "string" } }, "operation": { "description": "Type of update operation. Default operation type is REPLACE", "default": "REPLACE", "type": "string", "enum": [ "ADD", "REMOVE", "REPLACE" ] }, "preferred_locale": { "description": "Locale for the user. When setting this value, do not set use_browser_language\nto true, otherwise the browser's language setting will take precedence and the\npreferred_locale value will be ignored.", "type": "string", "enum": [ "en-CA", "en-GB", "en-US", "de-DE", "ja-JP", "zh-CN", "pt-BR", "fr-FR", "fr-CA", "es-US", "da-DK", "es-ES", "fi-FI", "sv-SE", "nb-NO", "pt-PT", "nl-NL", "it-IT", "ru-RU", "en-IN", "de-CH", "en-NZ", "es-MX", "en-AU", "zh-Hant", "ko-KR", "en-DE" ] }, "use_browser_language": { "description": "Flag to indicate whether to use the browser locale for the user in the UI.\nWhen set to true, the preferred_locale value is unset and the browser's\nlanguage setting takes precedence.
Version: 26.3.0.cl or later", "type": "boolean", "nullable": true }, "extended_properties": { "description": "Properties for the user", "type": "object" }, "extended_preferences": { "description": "Preferences for the user", "type": "object" } } }, "CreateVariableRequest": { "type": "object", "properties": { "type": { "description": "Type of variable", "type": "string", "enum": [ "CONNECTION_PROPERTY", "TABLE_MAPPING", "CONNECTION_PROPERTY_PER_PRINCIPAL", "FORMULA_VARIABLE" ] }, "name": { "description": "Name of the variable. This is unique across the cluster.", "type": "string" }, "is_sensitive": { "description": "If the variable contains sensitive values like passwords", "default": false, "type": "boolean", "nullable": true }, "data_type": { "description": "Variable Data Type, only for formula_variable type, leave empty for others
Version: 10.15.0.cl or later", "type": "string", "enum": [ "VARCHAR", "INT32", "INT64", "DOUBLE", "DATE", "DATE_TIME" ] } }, "required": [ "type", "name" ] }, "DeleteVariablesRequest": { "type": "object", "properties": { "identifiers": { "description": "Unique id(s), name(s), or object id(s) of the variable(s) to delete", "type": "array", "items": { "type": "string" } } }, "required": [ "identifiers" ] }, "PutVariableValuesRequest": { "type": "object", "properties": { "operation": { "description": "Operation to perform", "type": "string", "enum": [ "ADD", "REMOVE", "REPLACE", "RESET" ] }, "variable_assignment": { "description": "Variable assignments", "type": "array", "items": { "$ref": "#/components/schemas/VariablePutAssignmentInput" } } }, "required": [ "variable_assignment" ] }, "SearchVariablesRequest": { "type": "object", "properties": { "variable_details": { "description": "Variable details", "type": "array", "items": { "$ref": "#/components/schemas/VariableDetailInput" } }, "value_scope": { "description": "Array of scope filters", "type": "array", "items": { "$ref": "#/components/schemas/ValueScopeInput" } }, "record_offset": { "description": "The starting record number from where the records should be included", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "The number of records that should be included", "default": 10, "type": "integer", "format": "int32" }, "response_content": { "description": "Format in which we want the output", "default": "METADATA", "type": "string", "enum": [ "METADATA", "METADATA_AND_VALUES" ] } } }, "UpdateVariableRequest": { "type": "object", "properties": { "name": { "description": "New name of the variable.", "type": "string" } }, "required": [ "name" ] }, "UpdateVariableValuesRequest": { "type": "object", "properties": { "variable_assignment": { "description": "Array of variable assignment objects specifying the variable identifier, values to assign, and the operation type (ADD, REMOVE, REPLACE, or RESET) to perform on each variable.", "type": "array", "items": { "$ref": "#/components/schemas/VariableUpdateAssignmentInput" } }, "variable_value_scope": { "description": "Array of scope objects defining where the variable values apply, including organization context, optional principal constraints (user or group), model reference for formula variables, and priority for conflict resolution.", "type": "array", "items": { "$ref": "#/components/schemas/VariableUpdateScopeInput" } } }, "required": [ "variable_assignment", "variable_value_scope" ] }, "CommitBranchRequest": { "type": "object", "properties": { "metadata": { "description": "Metadata objects.", "type": "array", "items": { "$ref": "#/components/schemas/MetadataObject" } }, "delete_aware": { "description": "Delete the tml files from version control repo if it does not exist in the ThoughSpot instance", "default": true, "type": "boolean", "nullable": true }, "branch_name": { "description": " Name of the remote branch where object should be pushed\n \n\nNote: If no branch_name is specified, then the commit_branch_name will be considered.", "type": "string" }, "comment": { "description": "Comment to be added to the commit", "type": "string" } }, "required": [ "metadata", "comment" ] }, "CreateConfigRequest": { "type": "object", "properties": { "repository_url": { "description": "URL for connecting to remote repository", "type": "string" }, "username": { "description": "Username to authenticate connection to remote repository", "type": "string" }, "access_token": { "description": "Access token corresponding to the user to authenticate connection to remote repository", "type": "string" }, "org_identifier": { "description": " Applicable when Orgs is enabled in the cluster\n \n\nList of Org ids or name. Provide value -1 for cluster level. Example : [\"OrgID1-or-Name1\", \"OrgID2-or-Name2\"] \n\n\n \n\nNote: If no value is specified, then the configurations will be returned for all orgs the user has access to
Version: 9.5.0.cl or later", "type": "string" }, "branch_names": { "description": "List the remote branches to configure. Example:[development, production]", "type": "array", "items": { "type": "string" } }, "commit_branch_name": { "description": "Name of the remote branch where objects from this Thoughtspot instance will be versioned.
Version: 9.7.0.cl or later", "type": "string" }, "enable_guid_mapping": { "description": "Maintain mapping of guid for the deployment to an instance
Version: 9.4.0.cl or later", "default": true, "type": "boolean", "nullable": true }, "configuration_branch_name": { "description": " Name of the branch where the configuration files related to operations between Thoughtspot and version control repo should be maintained.\n \n\nNote: If no branch name is specified, then by default, ts_config_files branch is considered. Ensure this branch exists before configuration.
Version: 9.7.0.cl or later", "type": "string" } }, "required": [ "repository_url", "username", "access_token" ] }, "DeleteConfigRequest": { "type": "object", "properties": { "cluster_level": { "description": " Applicable when Orgs is enabled in the cluster\n \n\nIndicator to consider cluster level or org level config. Set it to false to delete configuration from current org. If set to true, then the configuration at cluster level and orgs that inherited the configuration from cluster level will be deleted.
Version: 9.5.0.cl or later", "type": "boolean", "nullable": true } } }, "DeployCommitRequest": { "type": "object", "properties": { "commit_id": { "description": " Commit_id against which the files should be picked to deploy.\n \n\nNote: If no commit_id is specified, then the head of the branch is considered.", "type": "string" }, "branch_name": { "description": "Name of the remote branch where changes should be picked", "type": "string" }, "deploy_type": { "description": "Indicates if all files or only modified file at specified commit point should be considered", "default": "DELTA", "type": "string", "enum": [ "FULL", "DELTA" ] }, "deploy_policy": { "description": "Define the policy to follow while importing TML in the ThoughtSpot environment. Use “ALL_OR_NONE” to cancel the deployment of all ThoughtSpot objects if at least one of them fails to import. Use “Partial” to import ThoughtSpot objects that validate successfully even if other objects in the same deploy operations fail to import.", "default": "ALL_OR_NONE", "type": "string", "enum": [ "ALL_OR_NONE", "PARTIAL", "VALIDATE_ONLY" ] } }, "required": [ "branch_name" ] }, "RevertCommitRequest": { "type": "object", "properties": { "metadata": { "description": "Metadata objects.", "type": "array", "items": { "$ref": "#/components/schemas/MetadataObject" } }, "branch_name": { "description": " Name of the branch where the reverted version should be committed\n \n\nNote: If no branch_name is specified, then the commit_branch_name will be considered.", "type": "string" }, "revert_policy": { "description": "Policy to apply when reverting a commit. Valid values: [ALL_OR_NONE, PARTIAL]", "default": "ALL_OR_NONE", "type": "string", "enum": [ "ALL_OR_NONE", "PARTIAL" ] } } }, "SearchCommitsRequest": { "type": "object", "properties": { "metadata_identifier": { "description": "Unique ID or name of the metadata.", "type": "string" }, "metadata_type": { "description": "Type of metadata.", "type": "string", "enum": [ "LIVEBOARD", "ANSWER", "LOGICAL_TABLE", "CUSTOM_ACTION" ] }, "branch_name": { "description": " Name of the branch from which commit history needs to be displayed.\n \n\nNote: If no branch_name is specified, then commits will be returned for the default branch for this configuration.", "type": "string" }, "record_offset": { "description": " Record offset point in the commit history to display the response.\n \n\nNote: If no record offset is specified, the beginning of the record will be considered.", "type": "integer", "format": "int32" }, "record_size": { "description": " Number of history records from record offset point to be displayed in the response.\n \n\nNote: If no record size is specified, then all the records will be considered.", "type": "integer", "format": "int32" } }, "required": [ "metadata_identifier" ] }, "SearchConfigRequest": { "type": "object", "properties": { "org_identifiers": { "description": " Applicable when Orgs is enabled in the cluster\n \n\nList of Org ids or name. Provide value -1 for cluster level. Example : [\"OrgID1-or-Name1\", \"OrgID2-or-Name2\"] \n\n\n \n\nNote: If no value is specified, then the configurations will be returned for all orgs the user has access to
Version: 9.5.0.cl or later", "type": "array", "items": { "type": "string" } } } }, "UpdateConfigRequest": { "type": "object", "properties": { "username": { "description": "Username to authenticate connection to version control system", "type": "string" }, "access_token": { "description": "Access token corresponding to the user to authenticate connection to version control system", "type": "string" }, "org_identifier": { "description": " Applicable when Orgs is enabled in the cluster\n \n\nList of Org ids or name. Provide value -1 for cluster level. Example : [\"OrgID1-or-Name1\", \"OrgID2-or-Name2\"] \n\n\n \n\nNote: If no value is specified, then the configurations will be returned for all orgs the user has access to
Version: 9.5.0.cl or later", "type": "string" }, "branch_names": { "description": "List the remote branches to configure. Example:[development, production]", "type": "array", "items": { "type": "string" } }, "commit_branch_name": { "description": "Name of the remote branch where objects from this Thoughtspot instance will be versioned.
Version: 9.7.0.cl or later", "type": "string" }, "enable_guid_mapping": { "description": "Maintain mapping of guid for the deployment to an instance
Version: 9.4.0.cl or later", "type": "boolean", "nullable": true }, "configuration_branch_name": { "description": "Name of the branch where the configuration files related to operations between Thoughtspot and version control repo should be maintained.
Version: 9.7.0.cl or later", "type": "string" } } }, "ValidateMergeRequest": { "type": "object", "properties": { "source_branch_name": { "description": "Name of the branch from which changes need to be picked for validation", "type": "string" }, "target_branch_name": { "description": "Name of the branch where files will be merged", "type": "string" } }, "required": [ "source_branch_name", "target_branch_name" ] }, "CreateWebhookConfigurationRequest": { "type": "object", "properties": { "name": { "description": "Name of the webhook configuration.", "type": "string" }, "description": { "description": "Description of the webhook configuration.", "type": "string" }, "url": { "description": "The webhook endpoint URL.", "type": "string" }, "url_params": { "description": "Additional URL parameters as key-value pairs.", "type": "object" }, "events": { "description": "List of events to subscribe to.", "type": "array", "items": { "type": "string", "enum": [ "LIVEBOARD_SCHEDULE" ] } }, "authentication": { "description": "Authorization configuration for the webhook.", "allOf": [ { "$ref": "#/components/schemas/WebhookAuthenticationInput" } ] }, "signature_verification": { "description": "Configuration for webhook signature verification.", "allOf": [ { "$ref": "#/components/schemas/WebhookSignatureVerificationInput" } ] }, "storage_destination": { "description": "Configuration for storage destination.\nAWS S3 example: {\"storage_type\": \"AWS_S3\", \"storage_config\": {\"aws_s3_config\": {\"bucket_name\": \"my-webhook-files\", \"region\": \"us-west-2\", \"role_arn\": \"arn:aws:iam::123456789012:role/ThoughtSpotDeliveryRole\", \"external_id\": \"ts-webhook-a1b2c3d4-7890\", \"path_prefix\": \"thoughtspot-webhooks/\"}}}\nGCP GCS example: {\"storage_type\": \"GCP_GCS\", \"storage_config\": {\"gcp_gcs_config\": {\"bucket_name\": \"my-webhook-files\", \"service_account_email\": \"my-sa@my-project.iam.gserviceaccount.com\", \"path_prefix\": \"webhooks/\"}}}
Version: 26.3.0.cl or later", "allOf": [ { "$ref": "#/components/schemas/StorageDestinationInput" } ] }, "additional_headers": { "description": "Additional headers as an array of key-value pairs.\nExample: [{\"key\": \"X-Custom-Header\", \"value\": \"custom_value\"}]
Version: 26.4.0.cl or later", "type": "array", "items": { "$ref": "#/components/schemas/WebhookKeyValuePairInput" } }, "status": { "description": "Status of the webhook (ENABLED or DISABLED). Optional — when omitted,\nstatus is not stored and will be absent from the response.
Version: 26.7.0.cl or later", "type": "string", "enum": [ "ENABLED", "DISABLED" ] } }, "required": [ "name", "url", "events" ] }, "DeleteWebhookConfigurationsRequest": { "type": "object", "properties": { "webhook_identifiers": { "description": "List of webhook identifiers to delete.", "type": "array", "items": { "type": "string" } } }, "required": [ "webhook_identifiers" ] }, "SearchWebhookConfigurationsRequest": { "type": "object", "properties": { "org_identifier": { "description": "Unique ID or name of the org.", "type": "string" }, "webhook_identifier": { "description": "Unique ID or name of the webhook.", "type": "string" }, "event_type": { "description": "Type of webhook event to filter by.", "type": "string", "enum": [ "LIVEBOARD_SCHEDULE" ] }, "record_offset": { "description": "The offset point, starting from where the webhooks should be included in the response.", "default": 0, "type": "integer", "format": "int32" }, "record_size": { "description": "The number of webhooks that should be included in the response starting from offset position.", "default": 50, "type": "integer", "format": "int32" }, "sort_options": { "description": "Sort option includes sort field and sort order.", "allOf": [ { "$ref": "#/components/schemas/WebhookSortOptionsInput" } ] }, "status": { "description": "Filter webhooks by status (ENABLED or DISABLED).
Version: 26.7.0.cl or later", "type": "string", "enum": [ "ENABLED", "DISABLED" ] } } }, "UpdateWebhookConfigurationRequest": { "type": "object", "properties": { "name": { "description": "Name of the webhook configuration.", "type": "string" }, "description": { "description": "Description of the webhook configuration.", "type": "string" }, "url": { "description": "The webhook endpoint URL.", "type": "string" }, "url_params": { "description": "Additional URL parameters as key-value pairs.", "type": "object" }, "events": { "description": "List of events to subscribe to.", "type": "array", "items": { "type": "string", "enum": [ "LIVEBOARD_SCHEDULE" ] } }, "authentication": { "description": "Authorization configuration for the webhook.", "allOf": [ { "$ref": "#/components/schemas/WebhookAuthenticationInput" } ] }, "signature_verification": { "description": "Configuration for webhook signature verification.", "allOf": [ { "$ref": "#/components/schemas/WebhookSignatureVerificationInput" } ] }, "storage_destination": { "description": "Configuration for storage destination.\nAWS S3 example: {\"storage_type\": \"AWS_S3\", \"storage_config\": {\"aws_s3_config\": {\"bucket_name\": \"my-webhook-files\", \"region\": \"us-west-2\", \"role_arn\": \"arn:aws:iam::123456789012:role/ThoughtSpotDeliveryRole\", \"external_id\": \"ts-webhook-a1b2c3d4-7890\", \"path_prefix\": \"thoughtspot-webhooks/\"}}}\nGCP GCS example: {\"storage_type\": \"GCP_GCS\", \"storage_config\": {\"gcp_gcs_config\": {\"bucket_name\": \"my-webhook-files\", \"service_account_email\": \"my-sa@my-project.iam.gserviceaccount.com\", \"path_prefix\": \"webhooks/\"}}}
Version: 26.3.0.cl or later", "allOf": [ { "$ref": "#/components/schemas/StorageDestinationInput" } ] }, "additional_headers": { "description": "Additional headers as an array of key-value pairs.\nExample: [{\"key\": \"X-Custom-Header\", \"value\": \"custom_value\"}]
Version: 26.4.0.cl or later", "type": "array", "items": { "$ref": "#/components/schemas/WebhookKeyValuePairInput" } }, "status": { "description": "Status of the webhook (ENABLED or DISABLED).
Version: 26.7.0.cl or later", "type": "string", "enum": [ "ENABLED", "DISABLED" ] }, "reset_options": { "description": "List of optional configuration sections to clear. Each value removes the\ncorresponding configuration entirely from the webhook: AUTHENTICATION\nremoves the authentication config, SIGNATURE_VERIFICATION removes the\nsignature verification config, STORAGE_DESTINATION removes the storage\ndestination config.
Version: 26.11.0.cl or later", "type": "array", "items": { "type": "string", "enum": [ "AUTHENTICATION", "SIGNATURE_VERIFICATION", "STORAGE_DESTINATION" ] } } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } }, "security": [ { "bearerAuth": [] } ], "servers": [ { "url": "{base-url}", "variables": { "base-url": { "default": "https://localhost:443" } } } ] }