REST API Reference

POST /tspublic/v1/user/
Creates a user account.

POST /tspublic/v1/user/activate
Activates a user account.

PUT /tspublic/v1/user/{userid}
Modifies a user account.

PUT /tspublic/v1/user/email
Add or modifies the email address of a user.

GET /tspublic/v1/user/
Gets details of the users in a ThoughtSpot system.

DELETE /tspublic/v1/user/{userid}
Deletes a user account.

GET /tspublic/v1/user/list
Gets all users, groups, and their inter-dependencies.

POST /tspublic/v1/user/updatepreference
Modifies a user profile.

POST /tspublic/v1/user/transfer/ownership
Transfers the ownership of objects from one user to another.

POST /tspublic/v1/user/updatepassword
Changes the password of a user account.

POST /tspublic/v1/user/resetpassword
Resets the password of a user account.

POST /tspublic/v1/user/session/invalidate
Invalidates a user session.

POST /tspublic/v1/user/inactivate
Deactivates a user account.

POST /tspublic/v1/user/sync
Synchronizes user details and attributes from an external database with the user data in the ThoughtSpot system.

POST /tspublic/v1/user/{userid}/groups
Assigns a user to the specified user groups.

GET /tspublic/v1/user/{userid}/groups
Gets details of the user groups associated with a specific user.

PUT /tspublic/v1/user/{userid}/groups
Updates the user group data for a specific user.

DELETE /tspublic/v1/user/{userid}/groups
Removes a user from the specified user groups.

POST /tspublic/v1/group/
Creates a user group.

PUT /tspublic/v1/group/{groupid}
Modifies a user group.

GET /tspublic/v1/group/
Gets details of a user group.

POST /tspublic/v1/group/{groupid}/user/{userid}
Assigns a user to a group.

GET /tspublic/v1/group/listuser/{groupid}
Gets a list of users assigned to a group.

POST /tspublic/v1/group/{groupid}/users
Adds users to a specific group.

PUT /tspublic/v1/group/{groupid}/users
Updates user data for a given group.

GET /tspublic/v1/group/{groupid}/users
Gets details of the users that are currently assigned to a group.

DELETE /tspublic/v1/group/{groupid}/users
Removes users from a group.

POST /tspublic/v1/group/addprivilege
Assigns a privilege to a user group.

POST /tspublic/v1/group/removeprivilege
Removes the privilege assigned to a group.

POST /tspublic/v1/group/{groupid}/groups
Assigns groups to a parent group.

PUT /tspublic/v1/group/{groupid}/groups
Updates subgroup objects for a given group.

GET /tspublic/v1/group/{groupid}/groups
Gets a list of subgroups for a given group object.

POST /tspublic/v1/group/addmemberships
Adds members to a group.

POST /tspublic/v1/group/removememberships
Removes members from a group.

DELETE /tspublic/v1/group/{groupid}/groups
Removes subgroups from a group.

DELETE /tspublic/v1/group/{groupid}/user/{userid}
Removes a user from a user group.

DELETE /tspublic/v1/group/{groupid}
Deletes a user group.

POST /tspublic/v1/session/login
Signs in a user to ThoughtSpot system.

POST /tspublic/v1/session/auth/token
Generates an authentication token for a user session.

GET /tspublic/v1/session/login/token
Creates a login session for authenticated users when trusted authentication is enabled.

This request method sends authentication attributes as query string parameters in the request URL.

POST /tspublic/v1/session/login/token
Authenticates and logs in a user to ThoughtSpot.

This request method sends authentication attributes in the request body as formData parameters. For a secure exchange of authentication information, ThoughtSpot recommends using the POST request method.

POST /tspublic/v1/session/logout
Logs out a user from an existing session.

POST /tspublic/v1/session/homepinboard
Sets a specific pinboard as a home pinboard.

GET /tspublic/v1/session/homepinboard
Returns the GUID of the pinboard that is set as a home pinboard for the current logged-in user.

DELETE /tspublic/v1/session/homepinboard
Removes the home pinboard settings for the current logged-in user.

POST /tspublic/v1/session/info
Gets session information.

POST /tspublic/v1/metadata/assigntag
Assigns tags to a metadata object, such as a pinboard, search answer, table, worksheet, or view.

POST /tspublic/v1/metadata/unassigntag
Removes tag associations to metadata objects.

GET /tspublic/v1/metadata/details
Gets metadata details for a specific data object such as a pinboard, search answer, or a worksheet.

GET /tspublic/v1/metadata/list
Gets a list of metadata objects from the ThoughtSpot system.

GET /tspublic/v1/metadata/listas
Gets a list of metadata objects for a user or user group.

GET /tspublic/v1/metadata/listobjectheaders
Lists metadata object headers in the repository.

GET /tspublic/v1/metadata/listvizheaders
Gets visualization headers from the ThoughtSpot system.

POST /tspublic/v1/metadata/markunmarkfavoritefor
Adds objects to favorites for a given user account.

DELETE /tspublic/v1/metadata/markunmarkfavoritefor
Removes the objects from a user’s favorites list.

POST /tspublic/v1/connection/create
Creates a data connection.

POST /tspublic/v1/connection/update
Modifies a data connection.

GET /tspublic/v1/connection/types
Gets a list of data connections that are currently operational on the ThoughtSpot cluster.

GET /tspublic/v1/connection/list
Gets a list of data connections set up for a live query service on the ThoughtSpot cluster.

GET /tspublic/v1/connection/export
Exports a data connection map.

POST /tspublic/v1/connection/delete
Deletes the specified data connections.

GET /tspublic/v1/admin/configinfo
Gets details of the current configuration of a ThoughtSpot cluster.

POST /tspublic/v1/admin/configinfo/update
Updates the configuration settings of the current ThoughtSpot cluster.

GET /tspublic/v1/admin/configinfo/override
Gets details of configuration overrides on the current ThoughtSpot cluster.

POST /tspublic/v1/materialization/refreshview/{id}
Allows you refresh a materialized view.

POST /tspublic/v1/metadata/tml/import
Imports scriptable in TML that represents objects in an editable and reusable format.

POST /tspublic/v1/metadata/tml/export
Exports ThoughtSpot objects represented in ThoughtSpot Modeling Language (TML).

POST /tspublic/v1/export/pinboard/pdf
Downloads a pinboard or specific visualizations from a pinboard as a PDF file.

POST /tspublic/v1/pinboarddata
Gets pinboard data from the ThoughtSpot application.

POST /tspublic/v1/searchdata
Allows searching for data from a specific data source in the ThoughtSpot application.

POST /tspublic/v1/dependency/listdependents
Gets a list of dependents for a given data object type.

GET /tspublic/v1/dependency/logicalcolumn
Gets a list of dependent objects for a logical column.

GET /tspublic/v1/dependency/logicaltable
Gets a list of dependent objects for data objects such as worksheets, tables, or views.

GET /tspublic/v1/dependency/logicalrelationship
Gets a list of dependent objects for table joins.

GET /tspublic/v1/dependency/physicalcolumn
Gets a list of dependent objects for a physical column.

GET /tspublic/v1/dependency/physicaltable
Gets a list of dependent objects for a physical table.

GET /tspublic/v1/dependency/pinboard
Gets a list of dependent object headers for a pinboard.

GET /tspublic/v1/dependency/listincomplete
Gets a list of objects with incomplete metadata.

POST /tspublic/v1/security/share
Shares ThoughtSpot objects with another user or user group.

POST /tspublic/v1/security/shareviz
Shares a specific visualization with another user or user group.

GET /tspublic/v1/security/metadata/permissions
Gets object permission details for a specific object type.

GET /tspublic/v1/security/metadata/{id}/permissions
Gets object permission details for a specific object ID.

GET /tspublic/v1/security/effectivepermissionbulk
Gets object permission details for multiple object types and IDs.

GET /tspublic/v1/database/tables
Gets a list of all tables in a database and schema in Falcon.

GET /tspublic/v1/database/schemas
Gets a list of all schemas in a particular database in Falcon.

GET /tspublic/v1/database/databases
Gets a list of all databases in Falcon.

GET /tspublic/v1/database/getTableDetail
Gets details of a particular table.

POST /tspublic/v1/database/createtable
Creates tables in a database.

POST /tspublic/v1/database/run
Runs TQL commands with SQL statements.