Signals Notebook: Worksheet Rendering and Export Limitations in Signals API

Description

If you would like to export worksheet data, please keep in mind the SNB API worksheet endpoints do not expose worksheet visual structure/order. Workarounds include exporting the parent experiment to PDF.

Solution

- The API does not provide worksheet visual structure (position/order/width)
• /worksheet/{eid}/_fields: returns field definitions in the order they were added to the worksheet, not visual order).
• /worksheet/{eid}: returns field values/content; rich text fields return HTML; other types return structured data.
• /entities/{eid}/pdf: does not support worksheets directly.
• /entities/export/pdf: can export the parent experiment; worksheets appear as child content with an experiment cover page.
 

- Recommended approaches:
• PDF export workaround: Use /entities/export/pdf for the parent experiment. If needed, programmatically remove the first (cover) page with a PDF library (e.g., PyPDF2).