ThoughtSpot

ThoughtSpot 9.12.0.cl API

The 9.12.0.cl API from ThoughtSpot — 1 operation(s) for 9.12.0.cl.

GitHub OpenAPI

Documentation

📖
Documentation
https://developers.thoughtspot.com/docs/rest-apiv2-reference
📖
GettingStarted
https://developers.thoughtspot.com/docs/rest-api-getstarted
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/thoughtspot/refs/heads/main/authentication/thoughtspot-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/thoughtspot/refs/heads/main/openapi/thoughtspot-9-12-0-cl-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/thoughtspot/refs/heads/main/errors/thoughtspot-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/thoughtspot/refs/heads/main/conventions/thoughtspot-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/thoughtspot/refs/heads/main/conventions/thoughtspot-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/thoughtspot/refs/heads/main/data-model/thoughtspot-data-model.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/thoughtspot/refs/heads/main/conformance/thoughtspot-conformance.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/thoughtspot/refs/heads/main/agentic-access/thoughtspot-agentic-access.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/thoughtspot/refs/heads/main/asyncapi/thoughtspot-webhooks.yml

OpenAPI Specification

thoughtspot-9-12-0-cl-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  title: ThoughtSpot Public REST 10.1.0.cl 9.12.0.cl API
  version: '2.0'
servers:
- url: '{base-url}'
  variables:
    base-url:
      default: https://localhost:443
security:
- bearerAuth: []
tags:
- name: 9.12.0.cl
paths:
  /api/rest/2.0/auth/token/validate:
    post:
      operationId: validateToken
      description: "\n <span class=\"since-beta-tag\">Version: 9.12.0.cl or later</span>\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:
      - 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
        '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.
components:
  schemas:
    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 metadata.
          nullable: true
        metadata_id:
          type: string
          description: Unique identifier of the Org.
          nullable: true
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          nullable: true
    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.
    ValidateTokenRequest:
      type: object
      properties:
        token:
          type: string
      required:
      - token
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
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: 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