diff --git a/modules/ROOT/pages/data-report-v2-api.adoc b/modules/ROOT/pages/data-report-v2-api.adoc index 42cbb14b7..5eb31f1ce 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. @@ -206,14 +206,26 @@ 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 include cover page, filters, and 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. -==== Example +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. + +[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 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 [source,cURL] ---- curl -X POST \