eabrahamyan - Hello,When we export a Liveboard...
# dev-help
e
Hello, When we export a Liveboard as PDF via the REST API, the generated PDF’s document metadata /Title is set to "ThoughtSpot". When users open the downloaded file, the PDF reader title bar shows "ThoughtSpot" instead of the Liveboard / report name. We rename the downloaded file correctly (e.g. My_Report_Name.pdf), but many PDF readers prefer the embedded document title over the filename, so the title bar still shows "ThoughtSpot". POST /api/rest/2.0/report/liveboard
Copy code
{
  "metadata_identifier": "<liveboard-guid>",
  "file_format": "PDF",
  "transient_content": "<optional transient content>",
  "pdf_options": {
    "include_cover_page": false,
    "include_filter_page": false
  }
}
Is there an existing parameter on /api/rest/2.0/report/liveboard to set the PDF document /Title metadata, or some workaround?
a
message has been deleted
s
Solution: Based on the official REST API schema for
POST /api/rest/2.0/report/liveboard
(
exportLiveboardReport
), there is no parameter to set PDF document metadata like
/Title
. The available
pdf_options
are limited to fields such as: -
include_cover_page
-
include_filter_page
-
include_custom_logo
-
include_page_number
-
page_orientation
-
page_size
-
zoom_level
-
truncate_table
-
page_footer_text
So today, you cannot set the embedded PDF title via this endpoint directly. A practical workaround is to post-process the exported PDF and set
/Title
yourself (e.g., with
qpdf
,
pikepdf
,
iText
,
PDFBox
, etc.) before delivering it to users. --- Suggestions: - Your current filename-rename approach is still worth keeping, but as you observed, many readers prioritize embedded metadata over filename. - If this is user-facing and high-volume, add a metadata-normalization step in your export pipeline: 1. Call ThoughtSpot export API. 2. Save PDF bytes. 3. Rewrite PDF metadata (
Title = Liveboard/report name
). 4. Return/download final PDF. - If you want this natively supported, raise a ThoughtSpot feature request for
pdf_options.title
(or similar) on
exportLiveboardReport
. --- Docs: - REST API v2 reference (Liveboard report export): https://developers.thoughtspot.com/docs/rest-api-v2#tag/Report/operation/exportLiveboardReport - Fetch data and report APIs guide: https://developers.thoughtspot.com/docs/fetch-data-and-report-apis - Developer docs home: https://developers.thoughtspot.com/docs
e
thank you