The Unofficial Guide to Tableau's Vizportal API
Welcome to the Tableau Vizportal API aka the “Undocumented API”. This API provides functionality for most operations on Tableau Server. The goal of this guide is to document the “undocumented” API so that you can perform tasks not possible with Tableau’s REST API or other command-line utilities.
To use this API you’ll need to first establish an HTTP session and connect to Vizportal via the following calls:
-
Generate Public Key: This key will be used to encrypt your password for the Login call
-
Login: You’ll want to retain the workgroup_session_id and XSRF-TOKEN that are returned in the response header’s Set-Cookie. The XSRF-TOKEN is required for the Request Header on subsequent calls to Vizportal.
All of the API methods detailed in this guide require secure authentication to Tableau Server with a registered user. All commands also honor Tableau Server’s inherent permissioning system.
Active Directory ¶
Get Last AD Group Sync Time ¶
Get Last AD Group Sync TimePOST/vizportal/api/web/v1/getLastActiveDirectoryGroupSyncTime
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getLastActiveDirectoryGroupSyncTime
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getLastActiveDirectoryGroupSyncTime",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Body
{
"result": {}
}Auth ¶
Generate Public Key ¶
Generate Public KeyPOST/vizportal/api/web/v1/generatePublicKey
When using Vizportal, this should be the first call that you make. There are 3 values that need to be captured and used to encrypt your password for a successful Login to occur:
-
keyId
-
modulus “n”
-
exponent “e”
Once you have these, use the RSA PKCS1 protocol to encrypt the password you’ll use to log in to Vizportal.
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/generatePublicKey
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "generatePublicKey",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Body
{
"result": {
"keyId": "qaZwwdvahYF0Tue0ugTNuM",
"key": {
"n": "9c979cf162b675ce6587b7f076e20ea40b2b58fe757c6bc51a4b6da788acdf6a753eec3cda9e4839023716e9c5239716df6bc4db1b5b1d95f8f9757f11926052085202a5bc4fea9405ccfa0b31c5094f47d344b17f534b969ea129f2d03ed5b01c668d",
"e": "10001"
}
}
}Schema
{
"type": "object",
"properties": {
"result": {
"type": "object",
"properties": {
"keyId": {
"type": "string"
},
"key": {
"type": "object",
"properties": {
"n": {
"type": "string"
},
"e": {
"type": "string"
}
}
}
}
}
}
}Get OAuth Credentials ¶
Get OAuth CredentialsPOST/vizportal/api/web/v1/getOAuthCredentials
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getOAuthCredentials
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getOAuthCredentials",
"params": {
"page": {
"startIndex": 0,
"maxItems": 1000
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Login ¶
LoginPOST/vizportal/api/web/v1/login
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/login
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "login",
"params": {
"username": "Admin",
"encryptedPassword": "Some String",
"keyId": "Another String"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"encryptedPassword": {
"type": "string"
},
"keyId": {
"type": "string"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"server": {
"defaultDomain": "local",
"version": {
"bitness": "64",
"build": "10000.16.1004.1720",
"externalVersion": {
"major": "10",
"minor": "0",
"patch": "2"
}
},
"siteCustomizationEnabled": false,
"featureFlags": {
"ha2Enabled": true,
"alertOnThresholdConditionEnabled": false,
"subscribeOnExtractRefreshEnabled": false,
"workbookVersionHistoryContentVersionLimitEnabled": true,
"dataSyncEnabled": false,
"contentDiscoveryPhase3Enabled": false,
"integratedDatasourcesUIEnabled": true,
"contentDiscoveryPhase2Enabled": true,
"desktopReportingEnabled": false,
"oauthWDCServerRefreshEnabled": true,
"contentDiscoveryPhase1Enabled": true,
"subscribeOthersEnabled": true,
"alertWhenDataPresentEnabled": false,
"workbookVersionHistoryViewDownloadDeleteEnabled": true,
"datasourceVersionHistoryViewDownloadDeleteEnabled": true,
"dataSyncLaunchFromWebEnabled": true,
"ha2FilestoreEnabled": true,
"dataIntegrationEnabled": true,
"connectedClientsTableEnabled": true,
"workbookVersionHistoryEnabled": true,
"lowDiskSpaceEnabled": true,
"oauthQuickBooksWDCServerRefreshEnabled": true
},
"oauthSalesforceEnabled": false,
"oauthQuickBooksEnabled": false,
"oauthGoogleEnabled": false,
"displaySchedulesInClientTimezone": true,
"refreshFailureNotificationEnabledForServer": true,
"displayScheduleDescriptionAsName": false,
"helpEdition": "server",
"supportHost": "",
"supportPath": "",
"datasourceHelpUrl": "",
"updateEmailAllowed": true,
"updateDisplayNameAllowed": true,
"sessionIdleLimitSeconds": 240,
"tabAdminServiceEnabled": true,
"alertLookBackDaysLimit": 14,
"siteAdminSettingsEnabled": false,
"defaultSubscriptionsEmail": "",
"logicalServerInstanceId": "",
"offlineHelpEnabled": false,
"rebuildingSearchIndex": false,
"alertFailureCountThreshold": 5
},
"site": {
"name": "Canada",
"id": "8",
"role": "Publisher",
"luid": "99faa865-2871-4d6a-994d-e815211dfd8c",
"urlName": "canada",
"refreshFailureNotificationEnabled": true,
"logoutEnabled": true,
"thirdPartyAuthState": {
"enabled": false,
"allowed": false,
"serverEnabled": false,
"hasThirdPartyAuthenticatedUsers": false
},
"versioningEnabled": true,
"liveDBAvailable": false
},
"user": {
"language": "en",
"id": "72",
"displayName": "Admin",
"locale": "en_US",
"username": "Admin",
"domainName": "local",
"displayMode": "list",
"startPage": "/",
"serverAdmin": true,
"numberOfSites": 7,
"canManageUsers": true
},
"isRestrictedTrustedTicketSession": false
}
}Data Connections ¶
Get Data Connections ¶
Get Data ConnectionsPOST/vizportal/api/web/v1/getDataConnections
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getDataConnections
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method":"getDataConnections",
"params":
{
"filter":
{
"operator":"and",
"clauses": [
{
"operator":"eq",
"field":"isPublished",
"value":true
}]
}
"order":
[
{
"field":"name",
"ascending":true
}
]
"page":
{
"startIndex":0,
"maxItems":0
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"filter": {
"type": "string"
},
"clauses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"field": {
"type": "string"
},
"value": {
"type": "boolean"
}
}
}
}
}
},
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "boolean"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"totalCount": 1,
"moreItems": false,
"dataConnections": [
{
"datasourceId": "2774",
"updatedAt": "2016-12-09T23:01:17.807Z",
"id": "2774",
"ownerId": "5",
"projectId": "27",
"isHierarchical": false,
"connectionOAuth": false,
"connectionTypeEditable": true,
"connectionTypeDisplayName": "PostgreSQL",
"connectionDetails": {
"serverPort": "8060",
"serverName": "localhost",
"hasEmbeddedPassword": true,
"databaseUserName": "readonly",
"type": "database"
},
"connectionType": "postgres"
}
],
"datasources": [
{
"name": "_groups (workgroup)",
"id": "2774",
"ownerId": "5",
"projectId": "27"
}
],
"workbooks": [],
"projects": [
{
"name": "test",
"id": "27"
}
],
"users": [
{
"id": "5",
"readOnly": false,
"displayName": "Admin",
"username": "Admin",
"domainName": "local",
"serverAdmin": true
}
]
}
}Check Connection ¶
Check ConnectionPOST/vizportal/api/web/v1/checkConnection
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/checkConnection
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "checkConnection",
"params": {
"id": "1103",
"server": "dbhost",
"port": "5430",
"username": "dbUserName",
"embedPassword": true
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"server": {
"type": "string"
},
"port": {
"type": "string"
},
"username": {
"type": "string"
},
"embedPassword": {
"type": "boolean"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"succeeded": true,
"messages": []
}
}Update Connections ¶
Update ConnectionsPOST/vizportal/api/web/v1/updateConnections
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateConnections
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateConnections",
"params": {
"ids": [
"1103"
],
"server": "dbhost",
"port": "5430",
"username": "dbUserName",
"embedPassword": true
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"server": {
"type": "string"
},
"port": {
"type": "integer",
"format": "int64"
},
"username": {
"type": "string"
},
"embedPassword": {
"type": "boolean"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"actionId": "36"
}
}Datasources ¶
Get Datasource Actions ¶
Get Datasource ActionsPOST/vizportal/api/web/v1/getDatasourceActions
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getDatasourceActions
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getDatasourceActions",
"params": {
"id": "47"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"launchWebAuthoring": true,
"download": true,
"setDisplayTabs": true,
"refreshExtract": true,
"setProject": true,
"del": true,
"versionManagement": true,
"setTags": true,
"setDescription": true,
"setPermissions": true,
"setOwner": true
}
}Get Datasource ¶
Get DatasourcePOST/vizportal/api/web/v1/getDatasource
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getDatasource
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getDatasource",
"params": {
"id": "1103"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Body
{
"result":{
"name":"Sample - Superstore"
"id":"47",
"owner":{
"id":"7",
"readOnly":false,
"displayName":"Publisher",
"username":"Publisher",
"domainName":"local",
"serverAdmin":false
},
"tags":[],
"datasourceId":"2",
"updatedAt":"2013-06-24T15:24:46.921Z",
"refreshMode":"Server",
"createdAt":"2013-06-24T15:24:46.921Z",
"project":{
"name":"Demos",
"id":"4"
},
"repositoryUrl":"Sample-Superstore",
"isHierarchical":false,
"connectionOAuth":false,
"connectionTypeEditable":false,
"favorite":false,
"downloadUrl":"/datasources/Sample-Superstore.tds",
"hasExtracts":true,
"hasAlert":false,
"connectionTypeDisplayName":"Tableau Data Engine",
"connectionDetails":{
"fileName":"Data\\Datasources\\Sample - Superstore Sales Multi-language (Extract).tde",
"hasEmbeddedPassword":false,
"type":"file"
},
"lastRefreshedAt":"2013-06-24T15:24:46.921Z",
"connectionType":"dataengine",
"newWorkbookUrl":"/authoringNewWorkbook/Sample-Superstore"
"hasIncrementalExtract":false,
"datasourceModifiedAt":"2016-12-23T16:53:23.926Z"
}
}Get Datasources ¶
Get DatasourcesPOST/vizportal/api/web/v1/getDatasources
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getDatasources
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getDatasources",
"params": {
"filter": {
"operator": "and",
"clauses": [
{
"operator": "eq",
"field": "isPublished",
"value": true
}
]
},
"order": [
{
"field": "hitsTotal",
"ascending": false
},
{
"field": "name",
"ascending": true
}
],
"page": {
"startIndex": 0,
"maxItems": 0
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"filter": {
"type": "string"
},
"clauses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
},
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "string"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"totalCount": 15,
"moreItems": true
}
}Get Datasource Versions ¶
Get Datasource VersionsPOST/vizportal/api/web/v1/getDatasourceVersions
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getDatasourceVersions
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method":"getDatasourceVersions",
"params":
{
"filter":
{
"operator":"and",
"clauses": [
{
"operator":"eq",
"field":"datasourceId",
"value":"1932"
}]
}
"order":
[
{
"field":"versionNumber",
"ascending":false
}
]
"page":
{
"startIndex":0,
"maxItems":0
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"filter": {
"type": "string"
},
"clauses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
},
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "boolean"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"totalCount": 1,
"moreItems": false,
"versions": [
{
"datasourceId": "2",
"id": "2@1",
"siteId": "1",
"versionNumber": 1,
"deleted": false,
"publisher": "Publisher",
"downloadUrl": "/datasources/history/Sample-Superstore_1.tds",
"publishTime": "2016-12-23T16:53:23.926Z",
"current": true
}
]
}
}Set Datasource Description ¶
Set Datasource DescriptionPOST/vizportal/api/web/v1/setDatasourceDescription
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/setDatasourceDescription
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "setDatasourceDescription",
"params": {
"id": "1018",
"description": "Datasource Description Text Goes Here"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Set Datasources Owner ¶
Set Datasources OwnerPOST/vizportal/api/web/v1/setDatasourcesOwner
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/setDatasourcesOwner
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "setDatasourcesOwner",
"params": {
"ids": [
"1018"
],
"ownerId": "5"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"ownerId": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Delete Datasources ¶
Delete DatasourcesPOST/vizportal/api/web/v1/deleteDatasources
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/deleteDatasources
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "deleteDatasources",
"params": {
"ids": [
"2875"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Delete Datasource Versions ¶
Delete Datasource VersionsPOST/vizportal/api/web/v1/deleteDatasourceVersions
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/deleteDatasourceVersions
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "deleteDatasourceVersions",
"params": {
"ids": [
"1469@1"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Move Datasources to Project ¶
Move Datasources to ProjectPOST/vizportal/api/web/v1/moveDatasourcesToProject
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/moveDatasourcesToProject
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "moveDatasourcesToProject",
"params": {
"ids": [
"47"
],
"projectId": "1"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"projectId": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Extracts ¶
Get Extract Tasks ¶
Get Extract TasksPOST/vizportal/api/web/v1/getExtractTasks
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getExtractTasks
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method":"getExtractTasks",
"params":
{
"filter":
{
"operator":"and",
"clauses":
[
{
"operator":"eq",
"field":"siteId",
"value":"1"
}
]
}
"order":
[
{
"field":"targetName",
"ascending":true
}
]
"page":
{
"startIndex":0,
"maxItems":0
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"clauses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
},
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "boolean"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"totalCount": 1,
"moreItems": true,
"tasks": [],
"datasources": [],
"workbooks": [],
"schedules": [],
"sites": []
}
}Set Extract Tasks Priority ¶
Set Extract Tasks PriorityPOST/vizportal/api/web/v1/setExtractTaskPriority
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/setExtractTaskPriority
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "setExtractTaskPriority",
"params": {
"ids": [
"55"
],
"priority": 49
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"priority": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Set Extract Tasks Schedule ¶
Set Extract Tasks SchedulePOST/vizportal/api/web/v1/setExtractTasksSchedule
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/setExtractTasksSchedule
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "setExtractTasksSchedule",
"params": {
"ids": [
"55"
],
"scheduleId": "1"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"scheduleId": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Create Extract Tasks ¶
Create Extract TasksPOST/vizportal/api/web/v1/createExtractTasks
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/createExtractTasks
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "createExtractTasks",
"params": {
"targetType": "Workbook",
"targetIds": [
"699"
],
"scheduleId": "2",
"type": "RefreshExtract"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"targetType": {
"type": "string"
},
"targetIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"scheduleId": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Delete Extract Tasks ¶
Delete Extract TasksPOST/vizportal/api/web/v1/deleteExtractTasks
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/deleteExtractTasks
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "deleteExtractTasks",
"params": {
"ids": [
"23"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Run Extract Tasks ¶
Run Extract TasksPOST/vizportal/api/web/v1/runExtractTasks
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/runExtractTasks
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "runExtractTasks",
"params": {
"ids": [
"55"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Favorites ¶
Add Favorite ¶
Add FavoritePOST/vizportal/api/web/v1/addFavorite
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/addFavorite
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "addFavorite",
"params": {
"objectId": "380",
"objectType": "workbook"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"objectId": {
"type": "integer",
"format": "int64"
},
"objectType": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Remove Favorite ¶
Remove FavoritePOST/vizportal/api/web/v1/removeFavorite
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/removeFavorite
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "removeFavorite",
"params": {
"objectId": "380",
"objectType": "workbook"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"objectId": {
"type": "integer",
"format": "int64"
},
"objectType": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Favorites ¶
Get FavoritesPOST/vizportal/api/web/v1/getFavorites
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getFavorites
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getFavorites",
"params": {
"page": {
"startIndex": 0,
"maxItems": 1000
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Body
{
"result":{
"totalCount":1,
"moreItems":false,
"favorites":[{
"id":"27",
"objectName":"Teams",
"position":"1",
"objectId":"1568",
"objectType":"view",
"objectOwnerId":"5",
"objectIdForFavoriting":"1568",
"objectOwnerName":"Admin",
"objectProjectId":"26",
"objectUpdatedAt":"2015-03-24T12:02:47.710Z",
"objectProjectName":"Wellness"
}],
"views"[{
"names":"Teams",
"id":"1568",
"path":"wellness_challenge/Teams",
"index":"1",
"updatedAt":"2015-03-24T12:02:47.710Z",
"workbookId":"462",
"usageInfo":{
"favoritesTotal":1,
"hitsLastThreeMonthsTotal":2,
"hitsLastOneMonthTotal":1,
"hitsLastTwelveMonthsTotal":3,
"hitsTotal":873
},
"thumbnailUrl":"vizportal/api/rest/v1/views/1568/thumbnail?1427198567710"
}],
"workbooks":[{
"name":"wellness_challenge",
"id":462,
"size":101998,
"ownerId":"5",
"displayTabs":true,
"updatedAt":"2015-03-24T12:02:47.804Z",
"defaultViewId":"1568",
"repositoryUrl":"wellness_challenge",
"projectId":"26",
"defaultViewUrl":"wellness_challenge/Teams",
"usageInfo":{
"favoritesTotal":0,
"hitsLastThreeMonthsTotal":2,
"hitsLastOneMonthTotal":1,
"hitsLastTwelveMonthsTotal":3,
"subscriptionsTotal":0,
"hitsTotal":1234
},
"downloadUrl":"/workbooks/wellness_challenge.twb",
"thumbnailUrl":"vizportal/api/rest/v1/workbooks/462/thumbnail?1427198567804",
"hasExtracts":false,
"hasAlert":false,
"sheetCount":2
}]
}
}Groups ¶
Create Group ¶
Create GroupPOST/vizportal/api/web/v1/createGroup
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/createGroup
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "createGroup",
"params": {
"name": "NameOfGroup"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Delete Groups ¶
Delete GroupsPOST/vizportal/api/web/v1/deleteGroups
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/deleteGroups
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "deleteGroups",
"params": {
"ids": [
"14"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Groups ¶
Get GroupsPOST/vizportal/api/web/v1/getGroups
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getGroups
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method":"getGroups",
"params":
{
"order":
[
{
"field":"name",
"ascending":true
}
]
"page":
{
"startIndex": 0,
"maxItems":0
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "boolean"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"totalCount": 2,
"moreItems": false,
"groups": [
{
"name": "All Users",
"id": "2",
"domainName": "local",
"userCount": 18,
"isAllUsersGroup": true
},
{
"name": "Test",
"id": "9",
"domainName": "local",
"userCount": 0,
"isAllUsersGroup": false
}
]
}
}Update Group Name ¶
Update Group NamePOST/vizportal/api/web/v1/updateGroupName
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateGroupName
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateGroupName",
"params": {
"groupId": "14",
"name": "UpdatedGroupName"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"groupId": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Permissions ¶
Get Effective Permissions ¶
Get Effective PermissionsPOST/vizportal/api/web/v1/getEffectivePermissions
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getEffectivePermissions
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method":"getEffectivePermissions":
"params":
{
"userIds":["27","6","25"],
"authorizables":
{
"type":"project",
"ids":["43"]
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"userIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"authorizables": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Explicit Permissions ¶
Get Explicit PermissionsPOST/vizportal/api/web/v1/getExplicitPermissions
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getExplicitPermissions
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getExplicitPermissions",
"params": {
"authorizables": {
"type": "project",
"ids": [
"43"
]
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"authorizables": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}
}Response
200Successful response
Body
{
"result":{
"permissions":[{
"authorizable":{
"type":"datasource",
"id":"47"
},
"grantee":{
"type":"user",
"id":"14"
},
"permissions":[{
"capability":"read",
"value":"allowed",
"reason":""
},
{
"capability":"write",
"value":"allowed",
"reason":""
}
]
}],
"users":[{
"id":"5",
"readOnly":false,
"displayName":"Admin",
"username":"Admin",
"domainName":"local",
"serverAdmin":true
}],
"groups":[{
"name":"All Users",
"id":"2",
"userCount":18,
"isAllUsersGroup":true
}],
"sourceAuthorizableById":{
"47":{
"id":"47",
"name":"Sample - Superstore"
"type":"datasource"
}
}
}
}Set Explicit Permissions ¶
Set Explicit PermissionsPOST/vizportal/api/web/v1/setExplicitPermissions
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/setExplicitPermissions
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "setExplicitPermissions",
"params": {
"permissions": [
{
"authorizable": {
"type": "project",
"id": "43"
},
"grantee": {
"type": "group",
"id": "2"
},
"permissions": [
{
"capability": "read",
"value": "allowed"
}
]
}
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"permissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"authorizable": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
}
}
},
"grantee": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
}
}
},
"permissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"capability": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Set Content Controlled Permissions ¶
Set Content Controlled PermissionsPOST/vizportal/api/web/v1/setContentControlledPermissions
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/setContentControlledPermissions
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "setContentControlledPermissions",
"params": {
"ids": [
"46"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Set Project Controlled Permissions ¶
Set Project Controlled PermissionsPOST/vizportal/api/web/v1/setProjectControlledPermissions
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/setProjectControlledPermissions
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "setProjectControlledPermissions",
"params": {
"ids": [
"46"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Projects ¶
Create Project ¶
Create ProjectPOST/vizportal/api/web/v1/createProject
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/createProject
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "createProject",
"params": {
"name": "ProjectName"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"id": 47
}
}Delete Projects ¶
Delete ProjectsPOST/vizportal/api/web/v1/deleteProjects
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/deleteProjects
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "deleteProjects",
"params": {
"ids": [
"43"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Project Actions ¶
Get Project ActionsPOST/vizportal/api/web/v1/getProjectActions
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getProjectActions
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getProjectActions",
"params": {
"id": "21"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"setName": true,
"del": true,
"setDescription": true,
"setPermissions": true,
"setOwner": true
}
}Get Project ¶
Get ProjectPOST/vizportal/api/web/v1/getProject
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getProject
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getProject",
"params": {
"id": "21"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"name": "Demos",
"id": "4",
"owner": {
"id": "5",
"readOnly": false,
"displayName": "Admin",
"username": "Admin",
"domainName": "local",
"serverAdmin": true
},
"description": "Demo/sample dashboards",
"updatedAt": "2013-06-07T13:26:53.937Z",
"createdAt": "2013-06-07T13:26:53.937Z",
"controlledPermissionsEnabled": false
}
}Get Projects ¶
Get ProjectsPOST/vizportal/api/web/v1/getProjects
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getProjects
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getProjects",
"params": {
"order": [
{
"field": "name",
"ascending": true
}
],
"page": {
"startIndex": 0,
"maxItems": 0
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "boolean"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Body
{
"result":
{
"totalCount": 26,
"moreItems": false,
"projects":[{
"name":"APITest"
"id":"21",
"description":"",
"ownerId":"5",
"viewCount":2,
"createdAt":"2016-12-23T16:54:07.739Z",
"controlledPermissionsEnabled":false,
"workbookCount":1,
"datasourceCount":0
}
],
"users":[{
"id":"5",
"readOnly":false,
"displayName":"Admin",
"username":"Admin",
"domainName":"local",
"serverAdmin":true
}
]
}
}Set Project Description ¶
Set Project DescriptionPOST/vizportal/api/web/v1/setProjectDescription
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/setProjectDescription
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "setProjectDescription",
"params": {
"id": "43",
"description": "Description Goes Here"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Set Project Name ¶
Set Project NamePOST/vizportal/api/web/v1/setProjectName
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/setProjectName
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "setProjectName",
"params": {
"id": "43",
"name": "Name of Project"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Set Projects Owner ¶
Set Projects OwnerPOST/vizportal/api/web/v1/setProjectsOwner
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/setProjectsOwner
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "setProjectsOwner",
"params": {
"ids": [
"43"
],
"ownerId": "73"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"ownerId": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Project Names ¶
Get Project NamesPOST/vizportal/api/web/v1/getProjectNames
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getProjectNames
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getProjectNames",
"params": {
"filter": {
"operator": "and",
"clauses": [
{
"operator": "eq",
"field": "id",
"value": "21"
}
]
},
"page": {
"startIndex": 0,
"maxItems": 1
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"clauses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Schedules ¶
Delete Schedules ¶
Delete SchedulesPOST/vizportal/api/web/v1/deleteSchedules
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/deleteSchedules
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "deleteSchedules",
"params": {
"ids": [
"10"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Remote Refresh Schedules ¶
Get Remote Refresh SchedulesPOST/vizportal/api/web/v1/getRemoteRefreshSchedules
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getRemoteRefreshSchedules
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getRemoteRefreshSchedules",
"params": {
"filter": {
"operator": "and",
"clauses": [
{
"operator": "eq",
"field": "datasourceId",
"value": "1018"
}
]
},
"order": [
{
"field": "runNextAt",
"ascending": true
}
],
"page": {
"startIndex": 0,
"maxItems": 0
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"clauses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
},
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "boolean"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"totalCount": 0,
"moreItems": false
}
}Get Schedules ¶
Get SchedulesPOST/vizportal/api/web/v1/getSchedules
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getSchedules
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getSchedules",
"params": {
"filter": {
"operator": "and",
"clauses": [
{
"operator": "eq",
"field": "datasourceId",
"value": "1018"
}
]
},
"order": [
{
"field": "runNextAt",
"ascending": true
}
],
"page": {
"startIndex": 0,
"maxItems": 0
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"clauses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
},
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "boolean"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"totalCount": 2,
"moreItems": false,
"schedules": [
{
"name": "4th of the Month",
"id": "42",
"priority": 50,
"runNextAt": "2017-02-04T00:00:00.000-05:00",
"taskCount": 0,
"parallel": false,
"serverTimezonOffset": -300,
"scheduledAction": "Extract",
"scheduleDetails": {
"startTime": 0,
"recurrencyDayOfMonth": "4"
},
"scheduleType": "Monthly"
},
{
"name": "Weekday early mornings",
"id": "1",
"priority": 50,
"runNextAt": "2017-01-09T00:00:00.000-05:00",
"taskCount": 3,
"parallel": true,
"serverTimezonOffset": -300,
"scheduledAction": "Extract",
"scheduleDetails": {
"startTime": 240,
"recurrencyDaysOfWeek": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri"
]
},
"scheduleType": "Weekly"
}
]
}
}Set Schedule Name ¶
Set Schedule NamePOST/vizportal/api/web/v1/setScheduleName
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/setScheduleName
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "setScheduleName",
"params": {
"id": "43",
"name": "Every Hour"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Create Schedule ¶
Create SchedulePOST/vizportal/api/web/v1/createSchedule
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/createSchedule
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "createSchedule",
"params": {
"name": "Name of Schedule",
"priority": 50,
"scheduleType": "Hourly",
"parallel": true,
"scheduleAction": "Extract",
"scheduleDetails": {
"startTime": 0,
"endTime": 0,
"recurrenceMinutes": 60
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"priority": {
"type": "integer",
"format": "int64"
},
"scheduleType": {
"type": "string"
},
"parallel": {
"type": "boolean"
},
"scheduleAction": {
"type": "string"
},
"scheduleDetails": {
"type": "object",
"properties": {
"startTime": {
"type": "integer",
"format": "int64"
},
"endTime": {
"type": "integer",
"format": "int64"
},
"recurrenceMinutes": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Run Server Schedules ¶
Run Server SchedulesPOST/vizportal/api/web/v1/runServerSchedules
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/runServerSchedules
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "runServerSchedules",
"params": {
"ids": [
"23"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Set Enabled Status for Schedules ¶
Set Enabled Status for SchedulesPOST/vizportal/api/web/v1/setEnabledStatusForSchedules
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/setEnabledStatusForSchedules
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "setEnabledStatusForSchedules",
"params": {
"ids": [
"42"
],
"enabled": true
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"enabled": {
"type": "boolean"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Server Settings ¶
Get Licensing Info ¶
Get Licensing InfoPOST/vizportal/api/web/v1/getLicensingInfo
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getLicensingInfo
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getLicensingInfo",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Body
{
"result": {
"isCore": false,
"productKeyInfo": [
{
"serial": "TS0D-XXXX-XXXX-XXXX-XXXX",
"numSeats": 10,
"maintenance": "2017-03-01T12:00:00.462Z",
"expiration": "2017-03-01T12:00:00.462Z",
"isValid": true,
"isGuestAllowed": false
}
],
"seatLicensingInfo": {
"numLicensedUsers": 9,
"numRemainingSeats": 1,
"numUnlicensedUsers": 13,
"isGuest": false
}
}
}Get Server Info ¶
Get Server InfoPOST/vizportal/api/web/v1/getServerInfo
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getServerInfo
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getServerInfo",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Server Settings ¶
Get Server SettingsPOST/vizportal/api/web/v1/getServerSettings
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getServerSettings
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getServerSettings",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Body
{
"result": {
"serverSettings": {
"defaultLocale": "en_US",
"savedPasswordEnabled": false,
"scheduledActiveDirectorySyncEnabled": false,
"schedulingEnabled": true,
"savedAccessTokensEnabled": false,
"embeddedCredentialsEnabled": true,
"defaultStartPage": "",
"refreshTokenEnabled": true,
"defaultLanguage": "en",
"activeDirectorySyncScheduleFrequency": {
"scheduleDetails": {
"startTime": 0
},
"scheduleType": "Daily"
}
}
}
}Get Worker Process Status ¶
Get Worker Process StatusPOST/vizportal/api/web/v1/getWorkerProcessStatus
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getWorkerProcessStatus
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getWorkerProcessStatus",
"params": {
"process": {
"type": "gateway",
"host": "WIN-XXXXXX",
"port": ":8000",
"preferred": false
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"process": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"host": {
"type": "string"
},
"port": {
"type": "string"
},
"preferred": {
"type": "boolean"
}
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Delete Ziplog ¶
Delete ZiplogPOST/vizportal/api/web/v1/deleteZiplog
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/deleteZiplog
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "deleteZiplog",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Generate Ziplog ¶
Generate ZiplogPOST/vizportal/api/web/v1/generateZiplog
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/generateZiplog
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "generateZiplog",
"params": {
"logsUpToDate": 0
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"logsUpToDate": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Ziplog Uri ¶
Get Ziplog UriPOST/vizportal/api/web/v1/getZiplogUri
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getZiplogUri
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getZiplogUri",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Rebuild Search Index ¶
Rebuild Search IndexPOST/vizportal/api/web/v1/rebuildSearchIndex
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/rebuildSearchIndex
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "rebuildSearchIndex",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Update Boolean Server Setting ¶
Update Boolean Server SettingPOST/vizportal/api/web/v1/updateBooleanServerSetting
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateBooleanServerSetting
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateBooleanServerSetting",
"params": {
"setting": "embeddedCredentialsEnabled",
"value": true
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"setting": {
"type": "string"
},
"value": {
"type": "boolean"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Update Schedule Frequency Server Setting ¶
Update Schedule Frequency Server SettingPOST/vizportal/api/web/v1/updateScheduleFrequencyServerSetting
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateScheduleFrequencyServerSetting
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateScheduleFrequencyServerSetting",
"params": {
"setting": "activeDirectorySyncScheduleFrequency",
"value": {
"scheduleType": "Daily",
"scheduleDetails": {
"startTime": 0
}
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"setting": {
"type": "string"
},
"value": {
"type": "object",
"properties": {
"scheduleType": {
"type": "string"
},
"scheduleDetails": {
"type": "object",
"properties": {
"startTime": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Update String Server Setting ¶
Update String Server SettingPOST/vizportal/api/web/v1/updateStringServerSetting
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateStringServerSetting
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateStringServerSetting",
"params": {
"setting": "defaultLanguage",
"value": "en"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"setting": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Sites ¶
Get Site Names Across All Pods ¶
Get Site Names Across All PodsPOST/vizportal/api/web/v1/getSiteNamesAcrossAllPods
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getSiteNamesAcrossAllPods
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getSiteNamesAcrossAllPods",
"params": {
"page": {
"startIndex": 0,
"maxItems": 1000
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItem": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"totalCount": 3,
"moreItems": false,
"siteNames": [
{
"name": "Canada",
"urlName": "canada"
},
{
"name": "Default",
"urlName": ""
},
{
"name": "US",
"urlName": "us"
}
]
}
}Get Site Names ¶
Get Site NamesPOST/vizportal/api/web/v1/getSiteNames
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getSiteNames
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getSiteNames",
"params": {
"page": {
"startIndex": 0,
"maxItems": 18
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItem": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Site Settings For Server Admin ¶
Get Site Settings For Server AdminPOST/vizportal/api/web/v1/getSiteSettingsForServerAdmin
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getSiteSettingsForServerAdmin
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getSiteSettingsForServerAdmin",
"params": {
"id": "1"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"id": "1",
"settings": {
"urlName": "",
"name": "Default",
"storageQuotaEnabled": false,
"siteAdminsCanAddUsers": true,
"userQuotaEnabled": false,
"metricsEnabled": true,
"authoringEnabled": true,
"sheetImageEnabled": true,
"versionHistoryEnabled": true,
"contentVersionLimitEnabled": true,
"contentVersionLimit": 25
},
"userCount": 17,
"adminCount": 2,
"availability": "active",
"licensedUserCount": 5,
"siteAdminSettings": {
"liveDBConnectionsWhitelistEnabled": false,
"refreshTokenEnabled": true,
"refreshFailureNotificationEnabled": true
},
"storageUsedBytes": 3843741466
}
}Get Site Settings for Site Admin ¶
Get Site Settings for Site AdminPOST/vizportal/api/web/v1/getSiteSettingsForSiteAdmin
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getSiteSettingsForSiteAdmin
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getSiteSettingsForSiteAdmin",
"params": {
"id": "1"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"id": "1",
"siteAdminSettings": {
"liveDBConnectionsWhitelistEnabled": false,
"refreshTokenEnabled": true,
"refreshFailureNotificationEnabled": true
}
}
}Get Sites ¶
Get SitesPOST/vizportal/api/web/v1/getSites
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getSites
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getSites",
"params": {
"order": [
{
"field": "name",
"ascending": true
}
],
"page": {
"startIndex": 0,
"maxItems": 20
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "boolean"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"totalCount": 1,
"moreItems": false,
"sites": [
{
"id": "1",
"settings": {
"urlName": "",
"name": "Default",
"storageQuotaEnabled": false,
"siteAdminsCanAddUsers": true,
"userQuotaEnabled": false,
"metricsEnabled": true,
"authoringEnabled": true,
"sheetImageEnabled": true,
"versionHistoryEnabled": true,
"contentVersionLimitEnabled": true,
"contentVersionLimit": 25
}
}
]
}
}Get Site Users ¶
Get Site UsersPOST/vizportal/api/web/v1/getSiteUsers
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getSiteUsers
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getSiteUsers",
"params": {
"filter": {
"operator": "and",
"clauses": [
{
"operator": "eq",
"field": "siteRole",
"value": "ServerAdministrator"
}
]
},
"order": [
{
"field": "displayName",
"ascending": true
}
],
"page": {
"startIndex": 0,
"maxItems": 0
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"clauses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
},
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "boolean"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Switch Site ¶
Switch SitePOST/vizportal/api/web/v1/switchSite
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/switchSite
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "switchSite",
"params": {
"urlName": "test"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"urlName": {
"type": "string"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"server": {
"defaultDomain": "local",
"version": {
"bitness": "64",
"build": "10000.16.1004.1720",
"externalVersion": {
"major": "10",
"minor": "0",
"patch": "2"
}
},
"siteCustomizationEnabled": false,
"featureFlags": {
"ha2Enabled": true,
"alertOnThresholdConditionEnabled": false,
"subscribeOnExtractRefreshEnabled": false,
"workbookVersionHistoryContentVersionLimitEnabled": true,
"dataSyncEnabled": false,
"contentDiscoveryPhase3Enabled": false,
"integratedDatasourcesUIEnabled": true,
"contentDiscoveryPhase2Enabled": true,
"desktopReportingEnabled": false,
"oauthWDCServerRefreshEnabled": true,
"contentDiscoveryPhase1Enabled": true,
"subscribeOthersEnabled": true,
"alertWhenDataPresentEnabled": false,
"workbookVersionHistoryViewDownloadDeleteEnabled": true,
"datasourceVersionHistoryViewDownloadDeleteEnabled": true,
"dataSyncLaunchFromWebEnabled": true,
"ha2FilestoreEnabled": true,
"dataIntegrationEnabled": true,
"connectedClientsTableEnabled": true,
"workbookVersionHistoryEnabled": true,
"lowDiskSpaceEnabled": true,
"oauthQuickBooksWDCServerRefreshEnabled": true
},
"oauthSalesforceEnabled": false,
"oauthQuickBooksEnabled": false,
"oauthGoogleEnabled": false,
"displaySchedulesInClientTimezone": true,
"refreshFailureNotificationEnabledForServer": true,
"displayScheduleDescriptionAsName": false,
"helpEdition": "server",
"supportHost": "",
"supportPath": "",
"datasourceHelpUrl": "",
"updateEmailAllowed": true,
"updateDisplayNameAllowed": true,
"sessionIdleLimitSeconds": 240,
"tabAdminServiceEnabled": true,
"alertLookBackDaysLimit": 14,
"siteAdminSettingsEnabled": false,
"defaultSubscriptionsEmail": "",
"logicalServerInstanceId": "",
"offlineHelpEnabled": false,
"rebuildingSearchIndex": false,
"alertFailureCountThreshold": 5
},
"site": {
"name": "Default",
"id": "1",
"role": "Publisher",
"luid": "ff66e08b-e7b4-4759-b21f-1fdc0e0885f9",
"urlName": "",
"refreshFailureNotificationEnabled": true,
"logoutEnabled": true,
"thirdPartyAuthState": {
"enabled": false,
"allowed": false,
"serverEnabled": false,
"hasThirdPartyAuthenticatedUsers": false
},
"versioningEnabled": true,
"liveDBAvailable": false
},
"user": {
"language": "en",
"id": "5",
"displayName": "Admin",
"locale": "en_US",
"username": "Admin",
"domainName": "local",
"displayMode": "list",
"startPage": "/",
"serverAdmin": true,
"numberOfSites": 7,
"canManageUsers": true
},
"isRestrictedTrustedTicketSession": false
}
}Create Site ¶
Create SitePOST/vizportal/api/web/v1/createSite
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/createSite
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "createSite",
"params": {
"settings": {
"urlName": "APITest",
"name": "APITest",
"storageQuotaEnabled": false,
"storageQuotaBytes": null,
"siteAdminsCanAddUsers": true,
"userQuotaEnabled": false,
"userQuota": null,
"metricsEnabled": false,
"authoringEnabled": true,
"sheetImageEnabled": true,
"versionHistoryEnabled": true,
"contentVersionLimitEnabled": true,
"contentVersionLimit": 25
},
"siteAdminSettings": {
"liveDBConnectionsWhitelistEnabled": false,
"refreshTokenEnabled": true,
"refreshFailureNotificationEnabled": true
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"settings": {
"type": "object",
"properties": {
"urlName": {
"type": "string"
},
"name": {
"type": "string"
},
"storageQuotaEnabled": {
"type": "boolean"
},
"storageQuotaBytes": {
"type": "integer",
"format": "int64"
},
"siteAdminsCanAddUsers": {
"type": "boolean"
},
"userQuotaEnabled": {
"type": "boolean"
},
"userQuota": {
"type": "integer",
"format": "int64"
},
"metricsEnabled": {
"type": "boolean"
},
"authoringEnabled": {
"type": "boolean"
},
"sheetImageEnabled": {
"type": "boolean"
},
"versionHistoryEnabled": {
"type": "boolean"
},
"contentVersionLimitEnabled": {
"type": "boolean"
},
"contentVersionLimit": {
"type": "integer",
"format": "int64"
}
}
},
"siteAdminSettings": {
"type": "object",
"properties": {
"liveDBConnectionsWhitelistEnabled": {
"type": "boolean"
},
"refreshTokenEnabled": {
"type": "boolean"
},
"refreshFailureNotificationEnabled": {
"type": "boolean"
}
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Delete Sites ¶
Delete SitesPOST/vizportal/api/web/v1/deleteSites
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/deleteSites
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "deleteSites",
"params": {
"ids": [
"9"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Subscriptions ¶
Get Subscriptions ¶
Get SubscriptionsPOST/vizportal/api/web/v1/getSubscriptions
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getSubscriptions
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getSubscriptions",
"params": {
"filter": {
"operator": "and",
"clauses": [
{
"operator": "eq",
"field": "siteId",
"value": "1"
}
]
},
"order": [
{
"field": "name",
"ascending": true
}
],
"page": {
"startIndex": 0,
"maxItems": 0
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"clauses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
},
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "boolean"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"totalCount": 0,
"moreItems": false,
"subscriptions": [],
"schedules": [],
"sites": [],
"users": []
}
}Users ¶
Change User Password ¶
Change User PasswordPOST/vizportal/api/web/v1/changeUserPassword
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/changeUserPassword
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "changeUserPassword",
"params": {
"userId": "50",
"oldEncryptedPassword": "Some String",
"keyId": "Another String"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"userId": {
"type": "integer",
"format": "int64"
},
"oldEncryptedPassword": {
"type": "string"
},
"keyId": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Check User Names ¶
Check User NamesPOST/vizportal/api/web/v1/checkUserNames
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/checkUserNames
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "checkUserNames",
"params": {
"usernames": [
"User to Check For"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"usernames": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Create Local User ¶
Create Local UserPOST/vizportal/api/web/v1/createLocalUser
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/createLocalUser
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "createLocalUser",
"params": {
"username": "TestUser",
"displayName": "Test User",
"email": "user@domain.com",
"encryptedPassword": "Some String",
"keyId": "Another String",
"admin": null,
"siteRole": "Viewer"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"displayname": {
"type": "string"
},
"email": {
"type": "string"
},
"encryptedPassword": {
"type": "string"
},
"keyId": {
"type": "string"
},
"admin": {
"type": "string"
},
"siteRole": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Delete My Saved Password & Credentials ¶
Delete My Saved Password & CredentialsPOST/vizportal/api/web/v1/deleteMySavedPasswordAndCredentials
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/deleteMySavedPasswordAndCredentials
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "deleteMySavedPasswordAndCredentials",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Delete Server Users ¶
Delete Server UsersPOST/vizportal/api/web/v1/deleteServerUsers
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/deleteServerUsers
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "deleteServerUsers",
"params": {
"ids": [
"50"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Delete Users ¶
Delete UsersPOST/vizportal/api/web/v1/deleteUsers
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/deleteUsers
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "deleteUsers",
"params": {
"ids": [
"88"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Server Users ¶
Get Server UsersPOST/vizportal/api/web/v1/getServerUsers
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getServerUsers
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getServerUsers",
"params": {
"filter": {
"operator": "and",
"clauses": [
{
"operator": "eq",
"field": "maxSiteRole",
"value": "ServerAdministrator"
}
]
},
"order": [
{
"field": "displayName",
"ascending": true
}
],
"page": {
"startIndex": 0,
"maxItems": 0
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"clauses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
},
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "boolean"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get User Alert Count ¶
Get User Alert CountPOST/vizportal/api/web/v1/getUserAlertCount
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getUserAlertCount
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getUserAlertCount",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Body
{
"result": {
"totalCount": 2
}
}Get User Connected Devices ¶
Get User Connected DevicesPOST/vizportal/api/web/v1/getUserConnectedDevices
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getUserConnectedDevices
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getUserConnectedDevices",
"params": {
"userId": "5"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"userId": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Users Group Membership ¶
Get Users Group MembershipPOST/vizportal/api/web/v1/getUsersGroupMembership
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getUsersGroupMembership
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getUsersGroupMembership",
"params": {
"userIds": [
"27",
"6",
"25"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"userIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Users ¶
Get UsersPOST/vizportal/api/web/v1/getUsers
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getUsers
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getUsers",
"params": {
"filter": {
"operator": "and",
"clauses": [
{
"operator": "has",
"field": "groupIds",
"value": 2
}
]
},
"order": [
{
"field": "displayName",
"ascending": true
}
],
"page": {
"startIndex": 0,
"maxItems": 18
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"clauses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
},
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "boolean"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Users Site Roles ¶
Get Users Sites RolesPOST/vizportal/api/web/v1/getUsersSiteRoles
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getUsersSiteRoles
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getUsersSiteRoles",
"params": {
"ids": [
"27"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Update Refresh Failure Notification Setting ¶
Update Refresh Failure Notification SettingPOST/vizportal/api/web/v1/updateRefreshFailureNotificationSetting
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateRefreshFailureNotificationSetting
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateRefreshFailureNotificationSetting",
"params": {
"userId": "113",
"enabled": false
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"userId": {
"type": "integer",
"format": "int64"
},
"enabled": {
"type": "boolean"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Update Server Users Admin Status ¶
Update Server Users Admin StatusPOST/vizportal/api/web/v1/updateServerUsersAdminStatus
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateServerUsersAdminStatus
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateServerUsersAdminStatus",
"params": {
"userIds": [
"50"
],
"admin": true
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"userIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"admin": {
"type": "boolean"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Update Server Users Site Membership ¶
Update Server Users Site MembershipPOST/vizportal/api/web/v1/updateServerUsersSiteMembership
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateServerUsersSiteMembership
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateServerUsersSiteMembership",
"params": {
"userIds": [
"50"
],
"addToSiteRoles": [
{
"siteId": "1",
"siteRole": "siteAdministrator"
}
],
"removeFromSiteIds": []
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"userIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"addToSiteRoles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"siteId": {
"type": "integer",
"format": "int64"
},
"siteRole": {
"type": "string"
}
}
}
},
"removeFromSiteIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Update User Display Name ¶
Update User Display NamePOST/vizportal/api/web/v1/updateUserDisplayName
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateUserDisplayName
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateUserDisplayName",
"params": {
"userId": "50",
"displayName": "Test User 2"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"userId": {
"type": "integer",
"format": "int64"
},
"displayName": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Update User Email ¶
Update User EmailPOST/vizportal/api/web/v1/updateUserEmail
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateUserEmail
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateUserEmail",
"params": {
"userId": "50",
"email": "test@test.com"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"userId": {
"type": "integer",
"format": "int64"
},
"email": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Update User Language ¶
Update User LanguagePOST/vizportal/api/web/v1/updateUserLanguage
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateUserLanguage
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateUserLanguage",
"params": {
"userId": "50",
"language": "en"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"userId": {
"type": "integer",
"format": "int64"
},
"language": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Update User Locale ¶
Update User LocalePOST/vizportal/api/web/v1/updateUserLocale
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateUserLocale
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateUserLocale",
"params": {
"userId": "50",
"locale": "en_US"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"userId": {
"type": "integer",
"format": "int64"
},
"locale": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Update User Local Time Zone Data ¶
Update User Local Time Zone DataPOST/vizportal/api/web/v1/updateUserLocalTimeZoneData
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateUserLocalTimeZoneData
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateUserLocalTimeZoneData",
"params": {
"offset": 480,
"dateString": "Thu Dec 15 2016 08:48:42 GMT-0800 (PST)"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"format": "int64"
},
"dateString": {
"type": "string"
}
}
}
}
}Response
200Successful response
Body
{
"result": {}
}Update User Group Membership ¶
Update User Group MembershipPOST/vizportal/api/web/v1/updateUserGroupMembership
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateUserGroupMembership
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateUserGroupMembership",
"params": {
"userIds": [
"113"
],
"addToGroupIds": [
"9"
],
"removeFromGroupIds": []
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"userIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"addToGroupIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"removeFromGroupIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Update Users Site Role ¶
Update Users Site RolePOST/vizportal/api/web/v1/updateUsersSiteRole
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateUsersSiteRole
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateUsersSiteRole",
"params": {
"userIds": [
"113"
],
"siteRole": "Interactor"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"userIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"siteRole": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Update User Start Page ¶
Update User Start PagePOST/vizportal/api/web/v1/updateUserStartPage
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateUserStartPage
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateUserStartPage",
"params": {
"startPage": "/projects"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"startPage": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get User Settings ¶
Get User SettingsPOST/vizportal/api/web/v1/getUserSettings
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getUserSettings
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getUserSettings",
"params": {
"username": "Admin",
"domainName": "local"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"domainName": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get User Alert List ¶
Get User Alert ListPOST/vizportal/api/web/v1/getUserAlertList
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getUserAlertList
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getUserAlertList",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Delete User Refresh Tokens ¶
Delete User Refresh TokensPOST/vizportal/api/web/v1/deleteUserRefreshTokens
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/deleteUserRefreshTokens
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "deleteUserRefreshTokens",
"params": {
"userId": "5"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"userId": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Views ¶
Get View Actions ¶
Get View ActionsPOST/vizportal/api/web/v1/getViewActions
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getViewActions
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getViewActions",
"params": {
"id": "1594"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"seeComments": true,
"launchWebAuthoring": true,
"del": true,
"setTags": true,
"setPermissions": true,
"addComment": true
}
}Get View by Path ¶
Get View by PathPOST/vizportal/api/web/v1/getViewByPath
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getViewByPath
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getViewByPath",
"params": {
"path": "WorkbookName/ViewName"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"path": {
"type": "string"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"name": "Teams",
"id": "1568",
"path": "wellness_challenge/Teams",
"owner": {
"id": "5",
"readOnly": false,
"displayName": "Admin",
"username": "Admin",
"domainName": "local",
"serverAdmin": true
},
"index": "1",
"tags": [],
"updatedAt": "2015-03-24T12:02:47.710Z",
"createdAt": "2015-03-24T12:02:47.679Z",
"project": {
"name": "Wellness",
"id": "26"
},
"workbook": {
"name": "wellness_challenge",
"id": "462",
"ownerId": "5",
"displayTabs": true,
"projectId": "26",
"sheetCount": 2
},
"hitsTimeSeries": [
0,
1,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"favorite": true,
"thumbnailUrl": "vizportal/api/rest/v1/views/1568/thumbnail?1427198567710",
"editUrl": "/authoring/wellness_challenge/Teams"
}
}Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Views ¶
Get ViewsPOST/vizportal/api/web/v1/getViews
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getViews
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getViews",
"params": {
"order": [
{
"field": "hitsTotal",
"ascending": false
},
{
"field": "name",
"ascending": true
}
],
"page": {
"startIndex": 0,
"maxItems": 0
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "boolean"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"totalCount": 639,
"moreItems": true,
"views": [
{
"name": "Teams",
"id": "1568",
"path": "wellness_challenge/Teams",
"index": "1",
"updatedAt": "2015-03-24T12:02:47.710Z",
"worbookId": "462",
"usageInfo": {
"favoritesTotal": 1,
"hitsLastThreeMonthsTotal": 1,
"hitsLastOneMonthTotal": 0,
"hitsLastTwelveMonthsTotal": 2,
"hitsTotal": 872
},
"thumbnailUrl": "vizportal/api/rest/v1/views/1568/thumbnail?1427198567710"
}
],
"workbooks": [
{
"name": "World Indicators",
"id": "1",
"ownerId": "4",
"displayTabs": true,
"projectId": "2",
"sheetCount": 7
}
],
"users": [
{
"id": "15",
"readOnly": false,
"displayName": "Admin",
"username": "Admin",
"domainName": "local",
"serverAdmin": true
}
],
"projects": [
{
"name": "Default",
"id": "17"
}
],
"favorites": [
"1568"
],
"maxStats": {
"hitsLastOneMonthTotal": 87,
"hitsLastThreeMonthsTotal": 419,
"hitsLastTwelveMonthsTotal": 422,
"hitsTotal": 872,
"favoritesTotal": 1
}
}
}Workbooks ¶
Get Workbook Actions ¶
Get Workbook ActionsPOST/vizportal/api/web/v1/getWorkbookActions
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getWorkbookActions
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getWorkbookActions",
"params": {
"id": "700"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"setName": true,
"launchWebAuthoring": true,
"download": true,
"setDisplayTabs": true,
"refreshExtract": true,
"setProject": true,
"del": true,
"versionManagement": true,
"setTags": true,
"setDescription": true,
"setPermissions": true,
"setOwner": true
}
}Get Workbook ¶
Get WorkbookPOST/vizportal/api/web/v1/getWorkbook
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getWorkbook
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getWorkbook",
"params": {
"id": "699"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Workbooks ¶
Get WorkbooksPOST/vizportal/api/web/v1/getWorkbooks
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getWorkbooks
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getWorkbooks",
"params": {
"order": [
{
"field": "hitsTotal",
"ascending": false
},
{
"field": "name",
"ascending": true
}
],
"page": {
"startIndex": 0,
"maxItems": 0
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "boolean"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"totalCount": 175,
"moreItems": false,
"workbooks": [
{
"name": "wellness_challenge",
"id": "462",
"size": 101998,
"ownerId": "5",
"displayTabs": true,
"updatedAt": "2015-03-24T12:02:47.804Z",
"defaultViewId": "1568",
"repositoryUrl": "wellness_challenge",
"projectId": "26",
"defaultViewUrl": "wellness_challenge/Teams",
"usageInfo": {
"favoritesTotal": 0,
"hitsLastThreeMonthsTotal": 2,
"hitsLastOneMonthTotal": 1,
"hitsLastTwelveMonthsTotal": 3,
"subscriptionsTotal": 0,
"hitsTotal": 1234
},
"downloadUrl": "/workbooks/wellness_challenge.twb",
"thumbnailUrl": "vizportal/api/rest/v1/workbooks/462/thumbnail?1427198567804",
"hasExtracts": false,
"hasAlert": false,
"sheetCount": 2
}
],
"users": [
{
"id": "5",
"readOnly": false,
"displayName": "Admin",
"username": "Admin",
"domainName": "local",
"serverAdmin": true
}
],
"projects": [
{
"name": "Default",
"id": "17"
}
],
"favorites": [],
"maxStats": {
"hitsLastOneMonthTotal": 183,
"hitsLastThreeMonthsTotal": 419,
"hitsLastTwelveMonthsTotal": 423,
"hitsTotal": 1234,
"favoritesTotal": 1,
"subscriptionsTotal": 0
}
}
}Get Workbook Versions ¶
Get Workbook VerionsPOST/vizportal/api/web/v1/getWorkbookVersions
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getWorkbookVersions
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getWorkbookVersions",
"params": {
"filter": {
"operator": "and",
"clauses": [
{
"operator": "eq",
"field": "workbookId",
"value": "462"
}
]
},
"order": [
{
"field": "versionNumber",
"ascending": false
}
],
"page": {
"startIndex": 0,
"maxItems": 1000
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"clauses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"operator": {
"type": "string"
},
"field": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
},
"order": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"ascending": {
"type": "boolean"
}
}
}
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Set Workbook Description ¶
Set Workbook DescriptionPOST/vizportal/api/web/v1/setWorkbookDescription
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/setWorkbookDescription
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "setWorkbookDescription",
"params": {
"id": "699",
"description": "Workbook Description Text"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Set Workbooks Owner ¶
Set Workbooks OwnerPOST/vizportal/api/web/v1/setWorkbooksOwner
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/setWorkbooksOwner
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "setWorkbooksOwner",
"params": {
"ids": [
"699"
],
"ownerId": "5"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"ownerId": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Delete Workbooks ¶
Delete WorkbooksPOST/vizportal/api/web/v1/deleteWorkbooks
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/deleteWorkbooks
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "deleteWorkbooks",
"params": {
"ids": [
"728"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Delete Workbook Versions ¶
Delete Workbook VersionsPOST/vizportal/api/web/v1/deleteWorkbookVersions
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/deleteWorkbookVersions
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "deleteWorkbookVersions",
"params": {
"ids": [
"728@1"
]
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Move Workbooks to Proejct ¶
Move Workbooks to ProjectPOST/vizportal/api/web/v1/moveWorkbooksToProject
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/moveWorkbooksToProject
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "moveWorkbooksToProject",
"params": {
"ids": [
"699"
],
"projectId": "20"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"projectId": {
"type": "integer",
"format": "int64"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Set Display Tabs ¶
Set Display TabsPOST/vizportal/api/web/v1/setDisplayTabs
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/setDisplayTabs
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "setDisplayTabs",
"params": {
"ids": [
"728"
],
"displayTabs": false
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"displayTabs": {
"type": "boolean"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Update Display Mode ¶
Update Display ModePOST/vizportal/api/web/v1/updateDisplayMode
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/updateDisplayMode
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "updateDisplayMode",
"params": {
"displayMode": "thumbnail"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"displayMode": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Uncategorized ¶
Get Actionable Objects ¶
Get Actionable ObjectsPOST/vizportal/api/web/v1/getActionableObjects
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getActionableObjects
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getActionableObjects",
"params": {
"authorizables": {
"type": "project",
"ids": [
"43"
]
}
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"authorizables": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Action Info ¶
Get Action InfoPOST/vizportal/api/web/v1/getActionInfo
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getActionInfo
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getActionInfo",
"params": {
"actionType": "rebuildSearchIndex"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"actionType": {
"type": "string"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"actions": [
{
"id": "36",
"state": "completed",
"type": "editConnections",
"response": {},
"succeeded": true,
"percentComplete": 100
}
]
}
}Get Getting Started Notifications ¶
Get Getting Started NotificationsPOST/vizportal/api/web/v1/getGettingStartedNotifications
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getGettingStartedNotifications
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getGettingStartedNotifications",
"params": {
"checkUserPrefs": false
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"checkUserPrefs": {
"type": "boolean"
}
}
}
}
}Response
200Successful response
Body
{
"result": {
"contentUrl": ""
}
}Get Languages ¶
Get LanguagesPOST/vizportal/api/web/v1/getLanguages
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getLanguages
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getLanguages",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Body
{
"result": {
"languages": [
{
"language": "en",
"displayName": "English",
"locale": "en_US"
},
{
"language": "fr",
"displayName": "Francais",
"locale": "fr_FR"
},
{
"language": "es",
"displayName": "Espanol",
"locale": "es_ES"
}
]
}
}Get Locales ¶
Get LocalesPOST/vizportal/api/web/v1/getLocales
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getLocales
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getLocales",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Body
{
"result": {
"locales": [
{
"displayName": "Albanian (Albania)",
"locale": "sq_AL"
},
{
"displayName": "Arabic (Algeria)",
"locale": "ar_DZ"
}
]
}
}Get Num Excess Revisions ¶
Get Num Excess RevisionsPOST/vizportal/api/web/v1/getNumExcessRevisions
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getNumExcessRevisions
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getNumExcessRevisions",
"params": {
"limit": 25
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"limit": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Remaining User Quota ¶
Get Remaining User QuotaPOST/vizportal/api/web/v1/getRemainingUserQuota
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getRemainingUserQuota
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getRemainingUserQuota",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Session Info ¶
Get Session InfoPOST/vizportal/api/web/v1/getSessionInfo
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getSessionInfo
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getSessionInfo",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Body
{
"result": {
"server": {
"defaultDomain": "local",
"version": {
"bitness": "64",
"build": "10000.16.1004.1720",
"externalVersion": {
"major": "10",
"minor": "0",
"patch": "2"
}
},
"siteCustomizationEnabled": false,
"featureFlags": {
"ha2Enabled": "true",
"alertOnThresholdConditionEnabled": false,
"subscribeOnExtractRefreshEnabled": false,
"workbookVersionHistoryContentVersionLimitEnabled": true,
"dataSyncEnabled": false,
"contentDiscoveryPhase3Enabled": false,
"integratedDatasourcesUIEnabled": true,
"contentDiscoveryPhase2Enabled": true,
"desktopReportingEnabled": false,
"oauthWDCServerRefreshEnabled": true,
"contentDiscoveryPhase1Enabled": true,
"subscribeOthersEnabled": true,
"alertWhenDataPresentEnabled": false,
"workbookVersionHistoryViewDownloadDeleteEnabled": true,
"datasourceVersionHistoryViewDownloadDeleteEnabled": true,
"dataSyncLaunchFromWebEnabled": true,
"ha2FilestoreEnabled": true,
"dataIntegrationEnabled": true,
"connectedClientsTableEnabled": true,
"workbookVersionHistoryEnabled": true,
"lowDiskSpaceEnabled": true,
"oauthQuickBooksWDCServerRefreshEnabled": true
},
"oauthSalesforceEnabled": false,
"oauthQuickBooksEnabled": false,
"oauthGoogleEnabled": false,
"displaySchedulesInClientTimezone": true,
"refreshFailureNotificationEnabledForServer": true,
"displayScheduleDescriptionAsName": false,
"helpEdition": "server",
"supportHost": "",
"supportPath": "",
"datasourceHelpUrl": "",
"updateEmailAllowed": true,
"updateDisplayNameAllowed": true,
"sessionIdleLimitSeconds": 240,
"tabAdminServiceEnabled": true,
"alertLookBackDaysLimit": 14,
"siteAdminSettingsEnabled": false,
"defaultSubscriptionsEmail": "",
"logicalServerInstanceId": "",
"offlineHelpEnabled": false,
"rebuildingSearchIndex": false,
"alertFailureCountThreshold": 5
},
"site": {
"name": "Default",
"id": "1",
"role": "Publisher",
"luid": "ff66e08b-e7b4-4759-b21f-1fdc0e0885f9",
"urlName": "",
"refreshFailureNotificationEnabled": true,
"logoutEnabled": true,
"thirdPartyAuthState": {
"enabled": false,
"allowed": false,
"serverEnabled": false,
"hasThirdPartyAuthenticatedUsers": false
},
"versioningEnabled": true,
"liveDBAvailable": false
},
"user": {
"language": "en",
"id": "5",
"locale": "en_US",
"username": "Admin",
"domainName": "local",
"displayMode": "list",
"startPage": "/",
"serverAdmin": true,
"numberOfSites": 7,
"canManageUsers": true
},
"isRestrictedTrustedTicketSession": false
}
}Get Total Refresh Token Count ¶
Get Total Refresh Token CountPOST/vizportal/api/web/v1/getTotalRefreshTokenCount
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getTotalRefreshTokenCount
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getTotalRefreshTokenCount",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Body
{
"result": {
"refreshTokenCount": 9
}
}Get Ziplog Info ¶
Get Ziplog InfoPOST/vizportal/api/web/v1/getZiplogInfo
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getZiplogInfo
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getZiplogInfo",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Mark Recently Viewed ¶
Mark Recently ViewedPOST/vizportal/api/web/v1/markRecentlyViewed
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/markRecentlyViewed
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "markRecentlyViewed",
"params": {
"objectId": "699",
"objectType": "workbook"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"objectId": {
"type": "integer",
"format": "int64"
},
"objectType": {
"type": "string"
}
}
}
}
}Response
200Successful response
Body
{
"result": {}
}Get Field Values ¶
Get Field ValuesPOST/vizportal/api/web/v1/getFieldValues
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getFieldValues
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getFieldValues",
"params": {
"field": "tags",
"labelMatchText": "",
"page": {
"startIndex": 0,
"maxItems": 22
},
"resourceType": "workbook"
}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"labelMatchText": {
"type": "string"
},
"page": {
"type": "object",
"properties": {
"startIndex": {
"type": "integer",
"format": "int64"
},
"maxItems": {
"type": "integer",
"format": "int64"
}
}
},
"resourceType": {
"type": "string"
}
}
}
}
}Response
200Successful response
Schema
{
"type": "string",
"properties": {
"result": {
"type": "object"
}
}
}Get Masthead Notifications ¶
Get Masthead NotificationsPOST/vizportal/api/web/v1/getMastheadNotifications
Example URI
POST http://YourTableauServer.com/vizportal/api/web/v1/getMastheadNotifications
Request
Headers
Content-Type: application/json;charset=UTF-8
accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_tokenBody
{
"method": "getMastheadNotifications",
"params": {}
}Schema
{
"type": "object",
"properties": {
"method": {
"type": "string"
},
"params": {
"type": "object"
}
}
}Response
200Successful response
Body
{
"result": {
"contentUrl": ""
}
}
Comments ¶
Create Comment ¶
/vizportal/api/web/v1/createCommentExample URI
Headers
Content-Type: application/json;charset=UTF-8accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_token
Body
{ "method": "createComment", "params": { "viewId": "3527", "text": "Your Comment Text Goes Here" } }Schema
{ "type": "object", "properties": { "method": { "type": "string" }, "params": { "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "text": { "type": "string" } } } } }200Successful response
Body
{ "result": { "id": "10" } }Schema
{ "type": "string", "properties": { "result": { "type": "object" } } }Delete Comment ¶
/vizportal/api/web/v1/deleteCommentExample URI
Headers
Content-Type: application/json;charset=UTF-8accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_token
Body
{ "method": "deleteComment", "params": { "id": "7" } }Schema
{ "type": "object", "properties": { "method": { "type": "string" }, "params": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" } } } } }200Successful response
Body
{ "result": {} }Get Comments ¶
/vizportal/api/web/v1/getCommentsExample URI
Headers
Content-Type: application/json;charset=UTF-8accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_token
Body
{ "method": "getComments", "params": { "viewId": "3527", "page": { "startIndex": 0, "maxItems": 10 } } }Schema
{ "type": "object", "properties": { "method": { "type": "string" }, "params": { "type": "object", "properties": { "viewId": { "type": "integer", "format": "int64" }, "page": { "type": "object", "properties": { "startIndex": { "type": "integer", "format": "int64" }, "maxItems": { "type": "integer", "format": "int64" } } } } } } }200Successful response
Body
{ "result": { "totalCount": 0, "moreItems": false, "comments": [ { "id": "10", "text": "Testing", "ownerId": "5", "updatedAt": "2017-01-06T18:54:51.095Z", "createdAt": "2017-01-06T18:54:51.095Z" } ], "users": [ { "id": "5", "readOnly": false, "displayName": "Admin", "username": "Admin", "domainName": "local", "serverAdmin": true } ] } }Update Comment ¶
/vizportal/api/web/v1/updateCommentExample URI
Headers
Content-Type: application/json;charset=UTF-8accept: application/json, text/plain, */*
cache-control: no-cache
X-XSRF-TOKEN: xsrf_token
Body
{ "method": "updateComment", "params": { "id": "7", "text": "Updated Comment Text Goes Here" } }Schema
{ "type": "object", "properties": { "method": { "type": "string" }, "params": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "text": { "type": "string" } } } } }200Successful response
Body
{ "result": {} }