List Custom Views
GET {{base-path}}/sites/{{site-id}}/customviews
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
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. When a request has a valid field expression, describing the attributes of a Tableau resource like a workbook or datasource, only the attributes specified in the expression will be present in the response. For example, a field expression that results in a response containing only the resources LUIDs of the resources being requested would look like: |
?field=id
You can qualify the expression to return values based upon predefined keywords such as default, which returns only default values, and all, which returns default and non-default values. You can include multiple field expressions in a request, and mix field, sort, and filter expressions in the same request.
The supported fields for custom views are its attributes: id, name, createdAt, updatedAt, and shared.
For more information, see Using Fields in the REST API. |
| fields | string | | (Optional) An expression that lets you filter which Tableau resources are present in the response. A filter expression has a resource, an operator, and a value. For example, a filter that returns only resources created after a specified date would look like:
?filter=createdAt:gt:2016-08-26T18:00:33Z (where gt is the greater-than operator)
You can include multiple filter expressions in a request, and mix field, sort, and filter expressions in the same request.
The supported filters for custom views use the eq (equals) operator, with the resources: viewId, ownerId, and workbookId.
For more information, see Filtering and Sorting in the Tableau REST APII. |
| sort | string | | (Optional) An expression that lets you sort the Tableau resources present in the response. A sort expression contains an attribute name and a direction (asc or desc). For example, a sort expression that sorts the requested resource by creation date with the latest date first would look like:
?sort=createdAt:desc
You can include multiple sort expressions in a request, and mix field, sort, and filter expressions in the same request.
The supported filters for custom views use the eq (equals) operator, with the resources: viewId, ownerId, and workbookId.
For more information, see Filtering and Sorting in the Tableau REST API. |