How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ThoughtSpot Custom Action API

The Custom Action API from ThoughtSpot — 4 operation(s) for custom action.

ThoughtSpot Custom Action API is one of 29 APIs that ThoughtSpot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Action. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.

This API exposes 4 operations across 4 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, {base-url}.

4 operations 4 paths 34 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://my.thoughtspot.cloud/api/rest/2.0
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

ThoughtSpot Custom Action API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Action 4
POST
/api/rest/2.0/customization/custom-actions
Version: 9.6.0.cl or later Creates a custom action that appears as a menu action on a saved Answer or Liveboard visualization. Requires DEVELOPER (Has Developer privilege) or ADMINISTRATION (Can admi…
createCustomAction body → 200400401403500
POST
/api/rest/2.0/customization/custom-actions/{custom_action_identifier}/delete
Version: 9.6.0.cl or later Removes the custom action specified in the API request. Requires DEVELOPER (Has Developer privilege) or ADMINISTRATION (Can administer ThoughtSpot) privilege. If [Role-Base…
deleteCustomAction 1 param → 204400401403500
POST
/api/rest/2.0/customization/custom-actions/search
Version: 9.6.0.cl or later Gets custom actions configured on the cluster. Requires DEVELOPER (Has Developer privilege) or ADMINISTRATION (Can administer ThoughtSpot) privilege. If [Role-Based Access…
searchCustomActions body → 200400401403500
POST
/api/rest/2.0/customization/custom-actions/{custom_action_identifier}/update
Version: 9.6.0.cl or later Updates a custom action. Requires DEVELOPER (Has Developer privilege) or ADMINISTRATION (Can administer ThoughtSpot) privilege. If [Role-Based Access Control (RBAC)](https:…
updateCustomAction 1 param body → 204400401403500

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are ResponseCustomAction (7 properties), SearchCustomActionsRequest (7 properties), UpdateCustomActionRequest (6 properties), CreateCustomActionRequest (5 properties). Each schema is shown below with its type and property counts.

ParametersListItemInput
object
2 properties
CreateCustomActionRequest
object
5 properties 2 required
Default_Action_Config_Input_Create
object
Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added t…
1 property
CustomActionMetadataTypeInput
object
MetadataType InputType used in Custom Action API's
2 properties 1 required
UpdateCustomActionRequest
object
6 properties
API_KeyInput
object
With API key auth, you send a key-value pair to the API either in the request headers or query parameters.
2 properties
URL
object
URL Custom Action Type
4 properties 1 required
SearchCustomActionsRequest
object
7 properties
ParametersListItem
object
2 properties
URLInputMandatory
object
URL Custom Action Type
4 properties 1 required
CALLBACK
object
CALLBACK Custom Action Type
1 property
ActionConfigInputCreate
object
Specify that the association is enabled for the metadata object Default
2 properties
AuthenticationInput
object
Authorization type for the custom action.
4 properties
Metadata_Association_Item
object
3 properties 3 required
Basic_Auth
object
Basic Auth: Basic authentication involves sending a verified username and password with your request.
2 properties
Default_action_config
object
Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added t…
1 property
Action_config
object
Specify that the association is enabled for the metadata object
2 properties
URLInput
object
URL Custom Action Type
4 properties
Action_Details_Input_Create
object
Action details includes Type and Configuration for Custom Actions, either Callback or URL is required. When both callback and url are provided, callback would…
2 properties
Authentication
object
Authorization type for the custom action.
4 properties
Associate_Metadata_Input
object
3 properties
ResponseCustomAction
object
Custom action details
7 properties 4 required
CALLBACKInput
object
CALLBACK Custom Action Type
1 property
Associate_Metadata_Input_Create
object
3 properties 1 required
CALLBACKInputMandatory
object
CALLBACK Custom Action Type
1 property
Object_ID_And_Name
object
The object representation with ID and Name.
2 properties
API_Key
object
With API key auth, you send a key-value pair to the API either in the request headers or query parameters.
2 properties
ErrorResponse
object
1 property
Action_details
object
Type and Configuration for Custom Actions
2 properties
ActionConfigInput
object
Specify that the association is enabled for the metadata object Default
2 properties
Default_Action_Config_Search_Input
object
Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added t…
1 property
Default_Action_Config_Input
object
Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added t…
1 property
Action_Details_Input
object
Action details includes Type and configuration details of Custom Actions. Either Callback or URL is required.
2 properties
Basic_AuthInput
object
Basic Auth: Basic authentication involves sending a verified username and password with your request.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thoughtspot-custom-action-api-openapi.yml Raw ↑

Other APIs ThoughtSpot publishes across the network.

ThoughtSpot AI API
ThoughtSpot Authentication API
ThoughtSpot Collections API
ThoughtSpot Connection Configurations API
ThoughtSpot Connections API
ThoughtSpot Custom Calendars API
ThoughtSpot Data API
ThoughtSpot DBT API
ThoughtSpot Email Customization API
ThoughtSpot Groups API
ThoughtSpot Input Tables API
ThoughtSpot Jobs API
Where this information came from

This is an independent, third-party profile of ThoughtSpot Custom Action API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.