ths-apimatic-sdk-sdk 1.0.0

ThoughtSpot APIMatic SDKs

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.

• bearerAuth (OAuth 2 Bearer token)

List of APIs

• Connection Configurations
• Custom Action
• Custom Calendars
• Email Customization
• Version Control
• AI
• Authentication
• Collections
• Connections
• Data
• DBT
• Groups
• Jobs
• Log
• Metadata
• Orgs
• Reports
• Roles
• Schedules
• Security
• System
• Tags
• Users
• Variable
• Webhooks

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime