@thoughtspot/rest-api-sdk

v2.9.1

Api sdk for thoughtspot's public v2 rest api For more information about how to use this package see README

Latest version published 1 month ago

License: ThoughtSpot Development Tools…

NPM

GitHub

Package Health Score

66 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.9.1	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.7.1	\|	10/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.4.1	\|	04/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.11.0	\|	06/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.10.0	\|	05/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

ThoughtSpot Development Tools End User License Agreement

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (481)

GitHub Stars: 6
Forks: 9
Contributors: 20

Direct Usage Popularity

The npm package @thoughtspot/rest-api-sdk receives a total of 481 downloads a week. As such, we scored @thoughtspot/rest-api-sdk popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @thoughtspot/rest-api-sdk, we found that it has been starred 6 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the @thoughtspot/rest-api-sdk repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like @thoughtspot/rest-api-sdk is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 3
Open PR: 31
Last Release: 1 month ago
Last Commit: 1 year ago

Further analysis of the maintenance status of @thoughtspot/rest-api-sdk based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that @thoughtspot/rest-api-sdk demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 3 Direct
Versions: 40
Install Size: 9.83 MB
Dist-tags: 2
# of Files: 318
Maintainers: 11
TS Typings: Yes

@thoughtspot/rest-api-sdk has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

@thoughtspot/rest-api-sdk@2.9.1

TypeScript/JavaScript client for ThoughtSpot's v2 Rest APIs.

Consuming

Navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @thoughtspot/rest-api-sdk --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Usage

Below code snippet shows how to create a simple config and use it to call the getUsers and getUserGroups apis.

import {
  ThoughtSpotRestApi,
  createBearerAuthenticationConfig
} from "@thoughtspot/rest-api-sdk";

const BASE_URL = "CLUSTER_URL";

const main = async () => {
  // getting the token
  const config = createBearerAuthenticationConfig(BASE_URL, {
    username: "YOUR_USERNAME",
    password: "YOUR_PASSWORD",
  });

  // create a thoughtspot client
  const tsRestApiClient = new ThoughtSpotRestApi(config);

  try {
    const users = await tsRestApiClient.searchUsers();
    console.log("Users on the cluster : ");
    users.forEach((user) => {
      console.log(user.name, user.email);
    });
  } catch (e) {
    console.log(e);
  }
};

main();

NOTE: For self certified ssl certificates, use the following config:

process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0"

Live Playground

We recommend that you browse through the code playground before you start constructing your API requests. The playground offers an interactive portal with comprehensive information about the API endpoints, request and response workflows.

@thoughtspot/rest-api-sdk dependencies

whatwg-fetch es6-promise url-parse

@thoughtspot/rest-api-sdk development dependencies

typescript @types/url-parse @types/chai @types/mocha ts-mocha @types/expect @types/chai-as-promised chai-as-promised tsup @swc/core chai mocha

FAQs

What is @thoughtspot/rest-api-sdk?

Api sdk for thoughtspot's public v2 rest api. Visit Snyk Advisor to see a full health score report for @thoughtspot/rest-api-sdk, including popularity, security, maintenance & community analysis.

Is @thoughtspot/rest-api-sdk popular?

The npm package @thoughtspot/rest-api-sdk receives a total of 481 weekly downloads. As such, @thoughtspot/rest-api-sdk popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @thoughtspot/rest-api-sdk well maintained?

We found indications that @thoughtspot/rest-api-sdk maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @thoughtspot/rest-api-sdk safe to use?

The npm package @thoughtspot/rest-api-sdk was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 12 November-2024, at 20:48 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP