API Reference

Retrieve a list of pivot views


Returns a paged list of views in the workspace of the request. If queryId is provided, the results are limited to only views associated with the query ID.

GET /api/v1/pivotview


Required OAuth Scopes:

No OAuth scopes are required to use this endpoint.


queryIdquerystringtrueThe unique query identifier to filter the views
limitqueryinteger(int32)falseThe number of views to return, from 1 to 1000; by default, 1000
cursorquerystringfalseA paging cursor; if included, limit is ignored
offsetqueryinteger(int64)falseThe item to start with on the page, greater than or equal to 0; by default, 0

Code Samples

curl -X GET https://h.app.wdesk.com/s/wdata/prep/api/v1/pivotview  \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}' -G \ 
--data-urlencoded "queryId=string"
http GET https://h.app.wdesk.com/s/wdata/prep/api/v1/pivotview  \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}" \
wget --method=GET "https://h.app.wdesk.com/s/wdata/prep/api/v1/pivotview?queryId=string" \
 --output-document -  \ 
 --header 'Accept: application/json' \ 
 --header 'Authorization: Bearer {access-token}'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'

r = requests.get('https://h.app.wdesk.com/s/wdata/prep/api/v1/pivotview', params={
  'queryId': 'string'
}, headers = headers)



200 - OK

Returns a JSON object with body and cursor properties.

  • body contains an array of PivotViewDto objects. If the request returns no results, body contains an empty array.
  • cursor contains a paging cursor, which can be included in the next call to the endpoint to retrieve the next set of results. If no additional results, cursor is null.

Example Responses

  "body": [
      "additionalMeta": {},
      "created": "string",
      "description": "string",
      "id": "string",
      "name": "string",
      "parentId": "string",
      "queryId": "string",
      "queryResultId": "string",
      "updated": "string",
      "userId": "string",
      "version": "integer"
  "code": "integer",
  "cursor": "string"