Query Workbooks for Site
GET {{base-path}}/sites/{{site-id}}/workbooks?filter=name:eq:Superstore
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
filter | string | (Optional) An expression that lets you specify a subset of workbooks to return. You can filter on predefined fields such as name, tags, and createdAt. You can include multiple filter expressions. For more information, see Filtering and Sorting. | |
sort | string | (Optional) An expression that lets you specify the order in which workbook information is returned. If you do not specify a sort expression, the sort order of the information that's returned is undefined. For more information, see Filtering and Sorting. | |
pageSize | string | (Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results. | |
pageNumber | string | (Optional) The offset for paging. The default is 1. For more information, see Paginating Results. | |
fields | string | (Optional) An expression that lets you specify the set of available fields to return. You can qualify the return values based upon predefined keywords such as all or default, and you can specify individual fields for the workbooks or other supported resources. You can include multiple field expressions in a request. For more information, see Using Fields in the REST API. | |
filter | string |