From 4b822d03483066a8bdd0bccbef5b9d4dc55ff002 Mon Sep 17 00:00:00 2001 From: rani2655 Date: Mon, 16 Jun 2025 21:32:04 +0530 Subject: [PATCH 01/10] lb report --- modules/ROOT/pages/data-report-v2-api.adoc | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/data-report-v2-api.adoc b/modules/ROOT/pages/data-report-v2-api.adoc index 42cbb14b7..e80b29973 100644 --- a/modules/ROOT/pages/data-report-v2-api.adoc +++ b/modules/ROOT/pages/data-report-v2-api.adoc @@ -195,7 +195,7 @@ To download a Liveboard report via `/api/rest/2.0/report/liveboard` API, you nee In the `POST` request body, specify the GUID or name of the Liveboard as `metadata_identifier`. To download reports with specific visualizations, add GUIDs or names of the visualizations in the `visualization_identifiers`. -To download visualizations from a specific Liveboard tab, specify the name or GUID of the tab in the `tab_identifiers` parameter. +To download visualizations from a specific Liveboard tab, specify the name or GUID of the tab in the `tab_identifiers` parameter. If you are working with PNG downloads contact ThoughtSpot support to enable this on your ThoughtSpot instance. To download a personalized view of the Liveboard, specify the view name in the `personalised_view_identifier` attribute. @@ -207,12 +207,14 @@ To download a personalized view of the Liveboard, specify the view name in the ` ==== The default `file_format` is PDF. For PDF downloads, you can specify additional parameters to customize the page orientation and include or exclude the cover page, logo, footer text, and page numbers. -You can also download the report in PNG format. For PNG downloads, you can include cover page, filters, and define +You can also download the report in PNG format. For PNG downloads, you can define * `image_resolution` * `image_scale` * `include_header` +Contact ThoughtSpot support to enable PNG downloads on your ThoughtSpot instance. + ==== Example [source,cURL] ---- From 5e2f41f2d62104a3813bb5d398b729cd4e0165b5 Mon Sep 17 00:00:00 2001 From: rani2655 Date: Tue, 17 Jun 2025 17:00:43 +0530 Subject: [PATCH 02/10] lb-report-update --- modules/ROOT/pages/data-report-v2-api.adoc | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/modules/ROOT/pages/data-report-v2-api.adoc b/modules/ROOT/pages/data-report-v2-api.adoc index e80b29973..c3c49d8a1 100644 --- a/modules/ROOT/pages/data-report-v2-api.adoc +++ b/modules/ROOT/pages/data-report-v2-api.adoc @@ -206,14 +206,22 @@ To download a personalized view of the Liveboard, specify the view name in the ` * Attempting to override existing filter values with runtime filters while exporting a Liveboard will result in an error. ==== -The default `file_format` is PDF. For PDF downloads, you can specify additional parameters to customize the page orientation and include or exclude the cover page, logo, footer text, and page numbers. -You can also download the report in PNG format. For PNG downloads, you can define +==== File Format -* `image_resolution` -* `image_scale` -* `include_header` +The default `file_format` is PDF. For PDF downloads, you can specify additional parameters to customize the page orientation and include or exclude the cover page, logo, footer text, and page numbers. You can also download the report in PNG format. -Contact ThoughtSpot support to enable PNG downloads on your ThoughtSpot instance. +For PNG downloads, you can now define + +* `image_resolution` [earlyAccess eaBackground]#Early Access# +* `image_scale` [earlyAccess eaBackground]#Early Access# +* `include_header` [earlyAccess eaBackground]#Early Access# + +Contact ThoughtSpot support to enable these settings for PNG downloads on your ThoughtSpot instance. + +[NOTE] +==== +If the above settings are enabled on your instance or you are using a ThoughtSpot release 10.9.0.cl or later, you will no longer be able to use the `include_cover_page`,`include_filter_page` within the `png_options`. +==== ==== Example [source,cURL] From ec1989a76fdf54185c95dab38adec069a22e6735 Mon Sep 17 00:00:00 2001 From: rani2655 Date: Mon, 23 Jun 2025 22:24:17 +0530 Subject: [PATCH 03/10] changed note --- modules/ROOT/pages/data-report-v2-api.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/data-report-v2-api.adoc b/modules/ROOT/pages/data-report-v2-api.adoc index c3c49d8a1..4abc46292 100644 --- a/modules/ROOT/pages/data-report-v2-api.adoc +++ b/modules/ROOT/pages/data-report-v2-api.adoc @@ -221,7 +221,8 @@ Contact ThoughtSpot support to enable these settings for PNG downloads on your T [NOTE] ==== If the above settings are enabled on your instance or you are using a ThoughtSpot release 10.9.0.cl or later, you will no longer be able to use the `include_cover_page`,`include_filter_page` within the `png_options`. -==== + +However, due to the UI limitation within the REST API playground, these options will continue to be visible despite enabling the above settings. This should have no impact on your API operation. ==== Example [source,cURL] From 869813ea9dd1eafa8bdfcf2259be05315bca80cf Mon Sep 17 00:00:00 2001 From: rani2655 Date: Tue, 24 Jun 2025 17:09:19 +0530 Subject: [PATCH 04/10] edited note --- modules/ROOT/pages/data-report-v2-api.adoc | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/modules/ROOT/pages/data-report-v2-api.adoc b/modules/ROOT/pages/data-report-v2-api.adoc index 4abc46292..5154ee1c0 100644 --- a/modules/ROOT/pages/data-report-v2-api.adoc +++ b/modules/ROOT/pages/data-report-v2-api.adoc @@ -220,11 +220,13 @@ Contact ThoughtSpot support to enable these settings for PNG downloads on your T [NOTE] ==== -If the above settings are enabled on your instance or you are using a ThoughtSpot release 10.9.0.cl or later, you will no longer be able to use the `include_cover_page`,`include_filter_page` within the `png_options`. - -However, due to the UI limitation within the REST API playground, these options will continue to be visible despite enabling the above settings. This should have no impact on your API operation. +* If the above settings are enabled on your instance or you are using a ThoughtSpot release 10.9.0.cl or later, you will no longer be able to use the `include_cover_page`,`include_filter_page` within the `png_options`. +* However, due to the UI limitation within the REST API playground, +** The `include_cover_page` and `include_filter_page` options will continue to be visible despite enabling the above settings. This should have no impact on your API operation. +** If the above settings are not enabled on your instance, the `include_header` will be added by default to your API payload, and must be manually deleted from the JSON map, for the API to function with PNG options. +==== -==== Example +Example [source,cURL] ---- curl -X POST \ From 530b9abf891401c4c3a3d0ef1ac966e69381a1ad Mon Sep 17 00:00:00 2001 From: rani2655 Date: Tue, 24 Jun 2025 17:22:34 +0530 Subject: [PATCH 05/10] edited note-recent --- modules/ROOT/pages/data-report-v2-api.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/data-report-v2-api.adoc b/modules/ROOT/pages/data-report-v2-api.adoc index 5154ee1c0..290212633 100644 --- a/modules/ROOT/pages/data-report-v2-api.adoc +++ b/modules/ROOT/pages/data-report-v2-api.adoc @@ -221,9 +221,9 @@ Contact ThoughtSpot support to enable these settings for PNG downloads on your T [NOTE] ==== * If the above settings are enabled on your instance or you are using a ThoughtSpot release 10.9.0.cl or later, you will no longer be able to use the `include_cover_page`,`include_filter_page` within the `png_options`. -* However, due to the UI limitation within the REST API playground, +* However, due to the limitations within the REST API playground, ** The `include_cover_page` and `include_filter_page` options will continue to be visible despite enabling the above settings. This should have no impact on your API operation. -** If the above settings are not enabled on your instance, the `include_header` will be added by default to your API payload, and must be manually deleted from the JSON map, for the API to function with PNG options. +** If the above settings are not enabled on your instance, the `include_header` will be added by default to your API payload and must be manually deleted from the JSON map for the API to function with PNG options. ==== Example From 71997e16f7a7441d74737536ee53b3059213e11b Mon Sep 17 00:00:00 2001 From: rani2655 Date: Wed, 25 Jun 2025 14:41:59 +0530 Subject: [PATCH 06/10] lb-export-report-edit --- modules/ROOT/pages/data-report-v2-api.adoc | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/modules/ROOT/pages/data-report-v2-api.adoc b/modules/ROOT/pages/data-report-v2-api.adoc index 290212633..9921aea70 100644 --- a/modules/ROOT/pages/data-report-v2-api.adoc +++ b/modules/ROOT/pages/data-report-v2-api.adoc @@ -218,12 +218,11 @@ For PNG downloads, you can now define Contact ThoughtSpot support to enable these settings for PNG downloads on your ThoughtSpot instance. -[NOTE] +[IMPORTANT] ==== * If the above settings are enabled on your instance or you are using a ThoughtSpot release 10.9.0.cl or later, you will no longer be able to use the `include_cover_page`,`include_filter_page` within the `png_options`. -* However, due to the limitations within the REST API playground, -** The `include_cover_page` and `include_filter_page` options will continue to be visible despite enabling the above settings. This should have no impact on your API operation. -** If the above settings are not enabled on your instance, the `include_header` will be added by default to your API payload and must be manually deleted from the JSON map for the API to function with PNG options. +* However, due to a UI limitation within the API Playground, the `include_cover_page` and `include_filter_page` options will continue to be visible despite enabling the above settings. This should have no impact on your API operation. +* If these settings are not enabled, and you select the `include_cover_page` and `include_filter_page` options, the API will return an error. Due to a UI limitation within the API Playground and the `include_header` is automatically added to the payload and must be manually deleted from the JSON for the API call to work correctly. ==== Example From c2af0defff7f41d56e43419767ad7ed64ae5ee95 Mon Sep 17 00:00:00 2001 From: rani2655 Date: Thu, 26 Jun 2025 14:19:14 +0530 Subject: [PATCH 07/10] edited NOTE --- modules/ROOT/pages/data-report-v2-api.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/modules/ROOT/pages/data-report-v2-api.adoc b/modules/ROOT/pages/data-report-v2-api.adoc index 9921aea70..5cd0de56c 100644 --- a/modules/ROOT/pages/data-report-v2-api.adoc +++ b/modules/ROOT/pages/data-report-v2-api.adoc @@ -221,8 +221,7 @@ Contact ThoughtSpot support to enable these settings for PNG downloads on your T [IMPORTANT] ==== * If the above settings are enabled on your instance or you are using a ThoughtSpot release 10.9.0.cl or later, you will no longer be able to use the `include_cover_page`,`include_filter_page` within the `png_options`. -* However, due to a UI limitation within the API Playground, the `include_cover_page` and `include_filter_page` options will continue to be visible despite enabling the above settings. This should have no impact on your API operation. -* If these settings are not enabled, and you select the `include_cover_page` and `include_filter_page` options, the API will return an error. Due to a UI limitation within the API Playground and the `include_header` is automatically added to the payload and must be manually deleted from the JSON for the API call to work correctly. +* Due to UI limitations within the API Playground, you may see additional parameters being automatically added to your request JSON when working with PNG downloads. To resolve this, click View JSON next to the png_options, delete the additional parameters and retry the API request. ==== Example From 1a819b2739f73e2f7c7e651a809639b8c1049569 Mon Sep 17 00:00:00 2001 From: rani2655 Date: Thu, 26 Jun 2025 14:24:05 +0530 Subject: [PATCH 08/10] edited NOTE-1 --- modules/ROOT/pages/data-report-v2-api.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/data-report-v2-api.adoc b/modules/ROOT/pages/data-report-v2-api.adoc index 5cd0de56c..018ee2830 100644 --- a/modules/ROOT/pages/data-report-v2-api.adoc +++ b/modules/ROOT/pages/data-report-v2-api.adoc @@ -221,7 +221,7 @@ Contact ThoughtSpot support to enable these settings for PNG downloads on your T [IMPORTANT] ==== * If the above settings are enabled on your instance or you are using a ThoughtSpot release 10.9.0.cl or later, you will no longer be able to use the `include_cover_page`,`include_filter_page` within the `png_options`. -* Due to UI limitations within the API Playground, you may see additional parameters being automatically added to your request JSON when working with PNG downloads. To resolve this, click View JSON next to the png_options, delete the additional parameters and retry the API request. +* Due to UI limitations within the API Playground, you may see additional parameters being automatically added to your request JSON when working with PNG downloads. To resolve this, click *View JSON* next to the `png_options`, delete the additional parameters and retry the API request. ==== Example From cfe6ccf88165228ec638b71c1da36495fbffd12b Mon Sep 17 00:00:00 2001 From: rani2655 Date: Thu, 26 Jun 2025 14:27:35 +0530 Subject: [PATCH 09/10] edited NOTE-2 --- modules/ROOT/pages/data-report-v2-api.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/data-report-v2-api.adoc b/modules/ROOT/pages/data-report-v2-api.adoc index 018ee2830..104ec95da 100644 --- a/modules/ROOT/pages/data-report-v2-api.adoc +++ b/modules/ROOT/pages/data-report-v2-api.adoc @@ -221,7 +221,7 @@ Contact ThoughtSpot support to enable these settings for PNG downloads on your T [IMPORTANT] ==== * If the above settings are enabled on your instance or you are using a ThoughtSpot release 10.9.0.cl or later, you will no longer be able to use the `include_cover_page`,`include_filter_page` within the `png_options`. -* Due to UI limitations within the API Playground, you may see additional parameters being automatically added to your request JSON when working with PNG downloads. To resolve this, click *View JSON* next to the `png_options`, delete the additional parameters and retry the API request. +* Due to UI limitations within the API Playground, you may see additional parameters being automatically added to your request JSON when working with PNG downloads, resulting in a 400 error. To resolve this, click *View JSON* next to the `png_options`, delete the additional parameters and retry the API request. ==== Example From 8909700be4fa3b8356798453d948ed0efebb6e01 Mon Sep 17 00:00:00 2001 From: rani2655 Date: Thu, 26 Jun 2025 14:35:47 +0530 Subject: [PATCH 10/10] edited NOTE-3 --- modules/ROOT/pages/data-report-v2-api.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/data-report-v2-api.adoc b/modules/ROOT/pages/data-report-v2-api.adoc index 104ec95da..5eb31f1ce 100644 --- a/modules/ROOT/pages/data-report-v2-api.adoc +++ b/modules/ROOT/pages/data-report-v2-api.adoc @@ -221,7 +221,8 @@ Contact ThoughtSpot support to enable these settings for PNG downloads on your T [IMPORTANT] ==== * If the above settings are enabled on your instance or you are using a ThoughtSpot release 10.9.0.cl or later, you will no longer be able to use the `include_cover_page`,`include_filter_page` within the `png_options`. -* Due to UI limitations within the API Playground, you may see additional parameters being automatically added to your request JSON when working with PNG downloads, resulting in a 400 error. To resolve this, click *View JSON* next to the `png_options`, delete the additional parameters and retry the API request. +* Due to UI limitations in the REST API Playground, you'll notice that some parameters are automatically included in the PNG options JSON. This may cause your API request to fail. As a workaround, click *View JSON* next to the `png_options`, review the parameters, remove additional parameters, and then click *Try it out*. + ==== Example