{
"opencollection": "1.0.0",
"info": {
"name": "ThoughtSpot Public REST 10.1.0.cl 26.4.0.cl API",
"version": "2.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "26.4.0.cl",
"type": "folder"
},
"items": [
{
"info": {
"name": "createCollection",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/collections/create",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\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, Logic"
},
{
"info": {
"name": "deleteCollection",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/collections/delete",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\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 d"
},
{
"info": {
"name": "searchCollections",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/collections/search",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\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_"
},
{
"info": {
"name": "updateCollection",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/collections/:collection_identifier/update",
"params": [
{
"name": "collection_identifier",
"value": "",
"type": "path",
"description": "Unique GUID of the collection. Note: Collection names cannot be used as\nidentifiers since duplicate names are allowed."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\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**"
},
{
"info": {
"name": "searchChannelHistory",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/jobs/history/communication-channels/search",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\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 yo"
},
{
"info": {
"name": "validateCommunicationChannel",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/system/communication-channels/validate",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\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 `ADMINISTR"
},
{
"info": {
"name": "createVariable",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/template/variables/create",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\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 "
},
{
"info": {
"name": "deleteVariables",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/template/variables/delete",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\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 ar"
},
{
"info": {
"name": "putVariableValues",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/template/variables/:identifier/update-values",
"params": [
{
"name": "identifier",
"value": "",
"type": "path",
"description": "Unique ID or name of the variable"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\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 s"
},
{
"info": {
"name": "searchVariables",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/template/variables/search",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\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* METADAT"
},
{
"info": {
"name": "updateVariable",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/template/variables/:identifier/update",
"params": [
{
"name": "identifier",
"value": "",
"type": "path",
"description": "Unique id or name of the variable to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\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"
}
]
}
],
"bundled": true
}