List workbook controls

This endpoint retrieves all controls associated with a specific workbook. Controls are interactive elements like checkboxes, or dropdowns used within the workbook for dynamic data interaction.

Usage notes

Usage scenarios

  • Dynamic data interaction: Allows users to interact dynamically with the data presented in the workbook through various control mechanisms.
  • Custom reporting: Enables the creation of customizable reports where end users can adjust parameters to filter and sort data according to their requirements.

Best practices

  • Ensure proper access controls are set to manage who can view or interact with the controls to prevent unauthorized data manipulation.
  • Use detailed and descriptive names for controls to facilitate easier identification and use by end users.
Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the workbook.

Query Params
string

Use to specify further pages using the string returned in the nextPage portion of the response.

number

Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.

Responses

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json