You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _app-integrate/data-api/about-data-api.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,22 +1,26 @@
1
1
---
2
-
title: [About the REST API]
2
+
title: [About the Data REST API]
3
3
keywords: REST,API,data,authentication,public
4
4
last_updated: tbd
5
5
summary: "The purpose of the REST API is to get data out of ThoughtSpot so you can use it in a Web page, portal, or application."
6
6
sidebar: mydoc_sidebar
7
7
permalink: /:collection/:path.html
8
8
---
9
-
When using the REST API, authentication is achieved through SAML. After authentication, use the POST method to call a URL for the desired visualization or pinboard. A JSON (JavaScript Object Notation) representation of the data will be returned.
9
+
When using the Data REST API, authentication is achieved through SAML. After authentication, use the POST method to call a URL for the desired visualization or pinboard. A JSON (JavaScript Object Notation) representation of the data will be returned.
10
10
11
11
## Authentication
12
12
13
-
Before you can use the REST API, you must authenticate to ThoughtSpot using SAML with the [JavaScript API]({{ site.baseurl }}/app-integrate/JSAPI/about-JS-API.html#).
13
+
Before you can use the Data REST API, you must authenticate to ThoughtSpot using SAML with the [JavaScript API]({{ site.baseurl }}/app-integrate/JSAPI/about-JS-API.html#).
14
14
15
15
## Cross Domain Verification
16
16
17
-
You'll need to enable cross domain verification when using the REST API. This protects your data, so that another website cannot use a URL to get data from ThoughtSpot. The procedure for [enabling the JavaScript API]({{ site.baseurl }}/app-integrate/JSAPI/enable-JS-API.html#) includes information on how to enable this.
17
+
You'll need to enable cross domain verification when using the Data REST API. This protects your data, so that another website cannot use a URL to get data from ThoughtSpot. The procedure for [enabling the JavaScript API]({{ site.baseurl }}/app-integrate/JSAPI/enable-JS-API.html#) includes information on how to enable this.
18
18
19
+
<<<<<<< HEAD
19
20
## REST API Capabilities
21
+
=======
22
+
## Data REST API capabilities
23
+
>>>>>>> 2a3dbdf3c... Add legal for Ext Enterprise Edition
20
24
21
25
Use a POST method to access the URL, which calls the REST API. The data is returned as a JSON string. When using this method, you'll need to extract the data from the JSON file and render it on your Web page, portal, or application.
Copy file name to clipboardExpand all lines: _app-integrate/data-api/response-pagination.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
---
2
-
title: [REST API pagination]
2
+
title: [Data REST API pagination]
3
3
keywords: REST,API,pagination,JSON,"REST API"
4
4
last_updated: tbd
5
5
summary: "You can paginate the JSON response that is called from the REST API. The order of the data is retained from page to page."
6
6
toc: false
7
7
sidebar: mydoc_sidebar
8
8
permalink: /:collection/:path.html
9
9
---
10
-
Given the ability to paginate, you can quickly populate tables and make new REST calls every time you go to the next page of the data on the table. There is significant load time if you want to populate the data table with many rows (greater than 1000) from the REST API.
10
+
Given the ability to paginate, you can quickly populate tables and make new REST calls every time you go to the next page of the data on the table. There is significant load time if you want to populate the data table with many rows (greater than 1000) from the Data REST API.
11
11
12
12
To paginate results in your API response, you'll need to add new parameters to the query:
Copy file name to clipboardExpand all lines: _app-integrate/data-api/use-data-api-read.md
+13-2Lines changed: 13 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,20 @@
1
1
---
2
-
title: [Use the REST API to get data]
2
+
title: [Use the Data REST API to get data]
3
3
keywords: REST,API,data,"REST API"
4
4
last_updated: tbd
5
5
summary: "This procedure shows how to use the REST API to get data out of ThoughtSpot, so you can use it in a Web page, portal, or application. "
6
6
sidebar: mydoc_sidebar
7
7
permalink: /:collection/:path.html
8
8
---
9
+
<<<<<<< HEAD
9
10
Data is returned as JSON (JavaScript Object Notation). Before you can use the REST API, you need to eEnable the JavaScript API (JS API)]({{ site.baseurl }}/app-integrate/JSAPI/enable-JS-API.html#) and authenticate to ThoughtSpot.
11
+
=======
12
+
Data retrieved using the Data REST API is returned as JSON (JavaScript Object Notation).
10
13
11
-
Use this procedure to construct the URL you will use to call the REST API:
14
+
Before you can use the Data REST API, you need to enable the [JavaScript API (JS API)]({{ site.baseurl }}/app-integrate/JSAPI/enable-JS-API.html#) and authenticate to ThoughtSpot.
15
+
>>>>>>> 2a3dbdf3c... Add legal for Ext Enterprise Edition
16
+
17
+
Use this procedure to construct the URL you will use to call the Data REST API:
12
18
13
19
1. Log in to ThoughtSpot from a browser.
14
20
2. Navigate to the pinboard from which you want to get data. If it doesn't exist yet, create it now.
@@ -50,5 +56,10 @@ Use this procedure to construct the URL you will use to call the REST API:
50
56
51
57
6. If you want to apply any filters to the data that will be returned, apply [Runtime Filters]({{ site.baseurl }}/app-integrate/runtime-filters/about-runtime-filters.html#).
52
58
7. Now your URL is complete, and you can use it to access the data directly via the HTTP POST method.
59
+
<<<<<<< HEAD
53
60
The REST API returns the data formatted as JSON.
61
+
=======
62
+
The Data REST API returns the data formatted as JSON.
63
+
64
+
>>>>>>> 2a3dbdf3c... Add legal for Ext Enterprise Edition
54
65
8. Retrieve the data from the JSON and display it in your Web page, Web portal, or application.
This guide explains how to integrate ThoughtSpot with other applications, including authentication, embedding, and APIs. For information on how to integrate with other data sources for loading data, refer to the Data Integration Guide.
10
+
=======
11
+
ThoughtSpot Extended Enterprise Edition lets you give people outside of your company access to some ThoughtSpot capabilities within the context of an external application, website, or portal. We’ll call these people “external users”. For example, you could give external users access to data, search, search results, data visualizations, and/or pinboards.
12
+
13
+
External users cannot be granted administrative privileges or receive technical support from ThoughtSpot. All first line support is to be handled through your company or organization.
14
+
15
+
ThoughtSpot Extended Enterprise Edition includes these capabilities:
When you buy ThoughtSpot Extended Enterprise, the following rights and obligations apply:
28
+
29
+
1. External users may only access those elements that are exposed through ThoughtSpot public APIs. These include search, search results and data visualizations, saved pinboard and answers, SearchIQ, and SpotIQ.
30
+
2. External users may not be granted Administrator privileges such as the ability to create and modify users and groups.
31
+
3. External users are not permitting to copy or download the ThoughtSpot software.
32
+
4. You may not include external users in a group that has access to these privileges:
33
+
- Can administer ThoughtSpot
34
+
- Can administer and bypass RLS
35
+
5. The license for Extended Enterprise does not enable you to act as an MSP (Managed Service Provider). This means that you must not offer managed services to third parties that are based on the ThoughtSpot software.
36
+
6. As a company offering access to ThoughtSpot Extended Enterprise to external users, you are responsible for your own data policy and for complying with local laws and regulations concerning data privacy, such as GDPR and HIPAA.
37
+
7. If you are using one of these capabilities, a NPS (Net Promoter Score) survey will be offered to your external users. You may not disable this survey:
38
+
- Application Embedding
39
+
- Embedded Search
40
+
41
+
If you’re using one of these types of embedding, it is okay to disable the NPS survey:
42
+
- Visualization Embedding
43
+
- Pinboard Embedding
44
+
45
+
8. Deployments of ThoughtSpot Extended Enterprise must conform to the [logo restrictions listed here](https://brand.thoughtspot.com/d/Vtg4Zg2mqTbE/brand-guidelines).
46
+
47
+
These are the branding elements you can change in ThoughtSpot Extended Enterprise:
9. You may not remove the *Powered by ThoughtSpot* logo that appears at the bottom right of the embedded application when using ThoughtSpot full application embed or embedding a pinboard. It is okay to remove the logo if you are embedding a single visualization.
56
+
57
+
Here are the top level topics on Embedding with Extended Enterprise:
58
+
59
+
*[Log in to the Linux shell using SSH]({{ site.baseurl }}/app-integrate/introduction/login-console.html)
Copy file name to clipboardExpand all lines: _app-integrate/reference/metadata-api.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,11 @@ sidebar: mydoc_sidebar
6
6
permalink: /:collection/:path.html
7
7
---
8
8
9
+
<<<<<<< HEAD
9
10
These two APIs work with metadata for objects in the system.
11
+
=======
12
+
The Metadata APIs enable you to fetch metadata details for various objects in the ThoughtSpot system. For example, you may want to see the visualization headers of a particular answer or a pinboard.
13
+
>>>>>>> 2a3dbdf3c... Add legal for Ext Enterprise Edition
0 commit comments