REST API v1 Reference

REST API v1 Reference

Starting from the ThoughtSpot Cloud ts8.nov.cl and ThoughtSpot Software 8.4.1.sw releases, pinboards are rebranded as Liveboards in ThoughtSpot UI, documentation, and learning resources. Note that the pinboard and PINBOARD_ANSWER_BOOK terminology in REST API v1 endpoint URLs, request and response workflows are not rebranded.

Orgs management🔗

API endpointAvailable from

POST /tspublic/v1/org/
Creates an Org object.

ThoughtSpot Cloud 8.10.0.cl
ThoughtSpot Software Not available

GET /tspublic/v1/org/
Gets an Org object.

ThoughtSpot Cloud 8.10.0.cl
ThoughtSpot Software Not available

PUT /tspublic/v1/org/
Edits the specified Org object.

ThoughtSpot Cloud 8.10.0.cl
ThoughtSpot Software Not available

POST /tspublic/v1/org/search
Gets all Org objects.

ThoughtSpot Cloud 8.10.0.cl
ThoughtSpot Software Not available

DELETE /tspublic/v1/org/
Deletes an Org object.

ThoughtSpot Cloud 8.10.0.cl
ThoughtSpot Software Not available

User management🔗

API endpointAvailable from

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

ThoughtSpot Cloud ts7.jun.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.1.1

PUT /tspublic/v1/user/email
Modifies the email address of a user.

ThoughtSpot Cloud ts7.oct.cl
ThoughtSpot Software 7.2.1

POST /tspublic/v1/user/addtoorg
Adds one or several users to the specified Org.

ThoughtSpot Cloud 8.10.0.cl
ThoughtSpot Software Not available

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

ThoughtSpot Cloud ts7.oct.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.oct.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.april.cl
ThoughtSpot Software 6.0.x

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

ThoughtSpot Cloud ts7.jun.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.april.cl
ThoughtSpot Software 6.0.x

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

ThoughtSpot Cloud ts7.april.cl
ThoughtSpot Software 6.0.x

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

POST /tspublic/v1/user/sync
Synchronizes user and group properties from an external database with the user data on ThoughtSpot.

ThoughtSpot Cloud ts7.april.cl
ThoughtSpot Software 6.0.x

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

ThoughtSpot Cloud ts7.oct.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.oct.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.oct.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.oct.cl
ThoughtSpot Software 7.2.1

Groups and privileges🔗

API endpointAvailable from

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.oct.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.oct.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.oct.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.oct.cl
ThoughtSpot Software 7.2.1

POST /tspublic/v1/group/addrole
Assigns a Role to a user group.

ThoughtSpot Cloud 9.7.0.cl
ThoughtSpot Software Not available

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

ThoughtSpot Cloud ts7.may.cl
ThoughtSpot Software 6.0.x

POST /tspublic/v1/group/removerole
Removes the Role assigned to a group.

ThoughtSpot Cloud 9.7.0.cl
ThoughtSpot Software Not available

POST /tspublic/v1/group/removeprivilege
Removes privileges assigned to a user group.

ThoughtSpot Cloud ts7.may.cl
ThoughtSpot Software 6.0.x

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.1.1

Roles🔗

API endpointAvailable from

POST /api/rest/2.0/roles/create
Creates a Role.

ThoughtSpot Cloud 9.7.0.cl
ThoughtSpot Software Not available

PUT /tspublic/v1/role/{role_identifier}
Edits the properties of a Role object.

ThoughtSpot Cloud 9.7.0.cl
ThoughtSpot Software Not available

POST /tspublic/v1/role/search
Gets Role objects.

ThoughtSpot Cloud 9.7.0.cl
ThoughtSpot Software Not available

DELETE /tspublic/v1/role/{role_identifier}
Removes a Role object from ThoughtSpot.

ThoughtSpot Cloud 9.7.0.cl
ThoughtSpot Software Not available

Session management🔗

API endpointAvailable from

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

ThoughtSpot Cloud ts7.april.cl
ThoughtSpot Software 6.0.x

POST /tspublic/v1/session/auth/token
Generates an authentication token for a user session.
Use this API endpoint to obtain a token for trusted authentication.

ThoughtSpot Cloud ts7.april.cl
ThoughtSpot Software 7.1.1

GET /tspublic/v1/session/login/token (Deprecated)
Authenticates and logs in a user using a token obtained from the /tspublic/v1/session/auth/token API call.
This request method sends authentication attributes as query string parameters in the request URL.
This API call is not required if you are using Visual Embed SDK.

ThoughtSpot Cloud ts7.may.cl
ThoughtSpot Software 7.1.1

POST /tspublic/v1/session/login/token
Authenticates and logs in a user using a token obtained from the /tspublic/v1/session/auth/token API call.
This request method sends authentication attributes in the request body as formData parameters. For secure exchange of authentication information, we recommend using the POST request method.
This API call is not required if you are using Visual Embed SDK.

ThoughtSpot Cloud ts8.nov.cl
ThoughtSpot Software 7.2.1.sw

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

ThoughtSpot Cloud ts7.april.cl
ThoughtSpot Software 6.0.x

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

ThoughtSpot Cloud ts7.oct.cl
ThoughtSpot Software 7.2.1

PUT /tspublic/v1/session/orgs
Allows switching between organizations on a multi-tenant instance.

ThoughtSpot Cloud 8.10.0.cl
ThoughtSpot Software Not available

GET /tspublic/v1/session/orgs
Gets Orgs for the logged-in user.

ThoughtSpot Cloud 8.10.0.cl
ThoughtSpot Software Not available

GET /tspublic/v1/session/orgs/users/{userid}
Gets Orgs for a specific user.

ThoughtSpot Cloud 8.10.0.cl
ThoughtSpot Software Not available

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

ThoughtSpot Cloud ts7.jun.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.jun.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.jun.cl
ThoughtSpot Software 7.1.1

Metadata management🔗

API endpointAvailable from

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

ThoughtSpot Cloud ts7.jun.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.jun.cl
ThoughtSpot Software 7.1.1

GET /tspublic/v1/metadata/list
Gets a list of all metadata objects from the ThoughtSpot resource repository.

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

The authorguid attribute is available from ThoughtSpot Cloud ts8.nov.cl and ThoughtSpot Software 8.4.1-sw onwards.

GET /tspublic/v1/metadata/listas
Gets a list of metadata objects that are available to a user or user group.

ThoughtSpot Cloud ts7.may.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.may.cl
ThoughtSpot Software 6.0.x

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

ThoughtSpot Cloud ts7.may.cl
ThoughtSpot Software 6.0.x

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

ThoughtSpot Cloud ts7.jun.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.jun.cl
ThoughtSpot Software 7.1.1

POST /tspublic/v1/metadata/delete
Deletes one or several metadata objects.

ThoughtSpot Cloud 9.0.0.cl
ThoughtSpot Software 9.0.1.sw

Configuration management🔗

API endpointAvailable from

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.1.1

GET /tspublic/v1/admin/embed/actions
Gets details of the custom actions enabled on the cluster.

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.2.1

GET /tspublic/v1/admin/embed/actions/{actionid}
Gets details of a specific custom action.

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.2.1

POST /tspublic/v1/admin/embed/actions
Creates a custom action

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.2.1

PUT /tspublic/v1/admin/embed/actions/{actionid}
Modifies the attributes of a custom action.

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.2.1

DELETE /tspublic/v1/admin/embed/actions/{actionid}
Deletes a custom action.

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.2.1

POST /tspublic/v1/admin/embed/actions/{actionid}/associations
Associates a custom action to a ThoughtSpot object.

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.2.1

GET /tspublic/v1/admin/embed/actions/{actionid}/associations
Gets the details of the ThoughtSpot objects associated with a custom action.

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.2.1

DELETE /tspublic/v1/admin/embed/actions/{actionid}/associations
Removes custom action associations.

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.2.1

Data connections🔗

API endpointAvailable from

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.1.1

POST /tspublic/v1/connection/fetchConnection
Gets metadata for a given connection ID.

ThoughtSpot Cloud 8.2.0.cl
ThoughtSpot Software 8.4.1-sw

POST /tspublic/v1/connection/fetchLiveColumns
Gets tables and column metadata a given connection ID.

ThoughtSpot Cloud 8.2.0.cl
ThoughtSpot Software 8.4.1-sw

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

TML objects🔗

API endpointAvailable from

POST /tspublic/v1/metadata/tml/import
Imports object representations in the ThoughtSpot Modeling Language (TML) format.

ThoughtSpot Cloud ts7.may.cl
ThoughtSpot Software 7.1.1

POST /tspublic/v1/metadata/tml/export
Exports objects from ThoughtSpot as TML representations.

ThoughtSpot Cloud ts7.may.cl
ThoughtSpot Software 7.1.1

POST /tspublic/v1/metadata/tml/export/batch
Exports user, user group, and Role objects in TML format.

ThoughtSpot Cloud 10.1.0.cl
ThoughtSpot Software 10.1.0.sw

Liveboard data🔗

API endpointAvailable from

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

ThoughtSpot Cloud ts7.april.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.april.cl
ThoughtSpot Software 6.0.x

Search data🔗

API endpointAvailable from

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

ThoughtSpot Cloud ts7.april.cl
ThoughtSpot Software 6.0.x

Dependent objects🔗

API endpointAvailable from

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.aug.cl
ThoughtSpot Software 7.2.1

Security🔗

API endpointAvailable from

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

ThoughtSpot Cloud ts7.jun.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.jun.cl
ThoughtSpot Software 7.1.1

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

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

ThoughtSpot Cloud ts7.sep.cl
ThoughtSpot Software 7.2.1

Audit logs🔗

API endpointAvailable from

GET /tspublic/v1/logs/topics/{topic}
Gets security audit logs from the ThoughtSpot system.

ThoughtSpot Cloud ts7.april.cl
ThoughtSpot Software Not applicable

Materialization service🔗

API endpointAvailable from

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

ThoughtSpot Cloud Not applicable
ThoughtSpot Software 6.0.x

Database and schema🔗

API endpointAvailable from

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

ThoughtSpot Cloud Not applicable
ThoughtSpot Software 6.3.1

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

ThoughtSpot Cloud Not applicable
ThoughtSpot Software 6.3.1

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

ThoughtSpot Cloud Not applicable
ThoughtSpot Software 6.3.1

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

ThoughtSpot Cloud Not applicable
ThoughtSpot Software 6.3.1

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

ThoughtSpot Cloud Not applicable
ThoughtSpot Software 6.3.1

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

ThoughtSpot Cloud Not applicable
ThoughtSpot Software 6.3.1