Skip to main content

Getting Started with ThoughtSpot Public REST API

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install ths-apimatic-sdk-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/ths-apimatic-sdk-sdk/1.0.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
base_url str Default: "https://localhost:443"
environment Environment The API environment.
Default: Environment.PRODUCTION
http_client_instance Union[Session, HttpClientProvider] The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 60
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ["GET", "PUT"]
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls
bearer_auth_credentials BearerAuthCredentials The credential object for OAuth 2 Bearer token

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from thoughtspotpublicrestapi.configuration import Environment
from thoughtspotpublicrestapi.http.auth.oauth_2 import BearerAuthCredentials
from thoughtspotpublicrestapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from thoughtspotpublicrestapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from thoughtspotpublicrestapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from thoughtspotpublicrestapi.thoughtspotpublicrestapi_client import ThoughtspotpublicrestapiClient

client = ThoughtspotpublicrestapiClient(
    bearer_auth_credentials=BearerAuthCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.PRODUCTION,
    base_url='https://localhost:443',
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from thoughtspotpublicrestapi.thoughtspotpublicrestapi_client import ThoughtspotpublicrestapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = ThoughtspotpublicrestapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name Description
PRODUCTION Default

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for ths-apimatic-sdk-sdk 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ths-apimatic-sdk-sdk 1.0.0
File Size Uploaded Provenance Actions
ths_apimatic_sdk_sdk-1.0.0.tar.gz 318.1 kB Without provenance Details for ths_apimatic_sdk_sdk-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ths-apimatic-sdk-sdk 1.0.0
File Interpreter ABI Platform Actions
ths_apimatic_sdk_sdk-1.0.0-py3-none-any.whl Python 3 none any Details for ths_apimatic_sdk_sdk-1.0.0-py3-none-any.whl

Total release size: 1.2 MB

Release files / ths_apimatic_sdk_sdk-1.0.0.tar.gz

Download URL ths_apimatic_sdk_sdk-1.0.0.tar.gz
Size 318.1 kB
Tags Source
SHA-256 checksum
How to use checksums
179fd600b5258b6ef97a0d3f5f3689cca849dad80105d8882293968149dda621
BLAKE2b-256 checksum
How to use checksums
3cd42b12700598ceaf00e635cd1a53129b30587d64114bdbda986b8957902ea9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / ths_apimatic_sdk_sdk-1.0.0-py3-none-any.whl

Download URL ths_apimatic_sdk_sdk-1.0.0-py3-none-any.whl
Size 930.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7f56a6b7a87172d25a1fd96492df15681568b526d519508674ff717bc611729d
BLAKE2b-256 checksum
How to use checksums
1d4252871179222834ee84923dacac0289bf55377cd985c0fdb9a0bcafb4a0da
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for ths-apimatic-sdk-sdk 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page