{ "opencollection": "1.0.0", "info": { "name": "Tableau REST API", "version": "3.24.0" }, "request": { "auth": { "type": "apikey", "key": "X-Tableau-Auth", "value": "{{X-Tableau-Auth}}", "placement": "header" } }, "items": [ { "info": { "name": "Authentication", "type": "folder" }, "items": [ { "info": { "name": "Tableau Sign in", "type": "http" }, "http": { "method": "POST", "url": "https://{server}/api/{api-version}/auth/signin", "body": { "type": "json", "data": "{}" } }, "docs": "Signs you in as a user on the specified site on Tableau Server or Tableau Cloud. This call returns an authentication token that you use in subsequent calls to the server. Typically, a credentials token is valid for 240 minutes." }, { "info": { "name": "Tableau Sign Out", "type": "http" }, "http": { "method": "POST", "url": "https://{server}/api/{api-version}/auth/signout" }, "docs": "Signs you out of the current session. This invalidates the authentication token." }, { "info": { "name": "Tableau Switch Site", "type": "http" }, "http": { "method": "POST", "url": "https://{server}/api/{api-version}/auth/switchSite", "body": { "type": "json", "data": "{}" } }, "docs": "Switches you to the specified site without having to provide a user name and password again. The new site must be on the same server." } ] }, { "info": { "name": "Sites", "type": "folder" }, "items": [ { "info": { "name": "Tableau Query Sites", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to return in one response. The minimum is 1 and the maximum is 1000." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number of the set of items to return. The default is 1." } ] }, "docs": "Returns a list of the sites on the server that the caller has access to. This method is available to Tableau Server administrators." }, { "info": { "name": "Tableau Create Site", "type": "http" }, "http": { "method": "POST", "url": "https://{server}/api/{api-version}/sites", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a site on Tableau Server. To create a site, you must be a server administrator. Not available for Tableau Cloud." }, { "info": { "name": "Tableau Query Site", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "includeUsageStatistics", "value": "true", "type": "query", "description": "If true, returns usage statistics for the site." } ] }, "docs": "Returns information about the specified site, with the option to return information about the storage space and the number of users." }, { "info": { "name": "Tableau Update Site", "type": "http" }, "http": { "method": "PUT", "url": "https://{server}/api/{api-version}/sites/:site-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the settings for the specified site, including the name, URL namespace, storage quota, and other settings." }, { "info": { "name": "Tableau Delete Site", "type": "http" }, "http": { "method": "DELETE", "url": "https://{server}/api/{api-version}/sites/:site-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." } ] }, "docs": "Deletes the specified site. Deleting a site also deletes all content on the site including workbooks, data sources, users, etc." } ] }, { "info": { "name": "Projects", "type": "folder" }, "items": [ { "info": { "name": "Tableau Query Projects", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/projects", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to return in one response. The minimum is 1 and the maximum is 1000." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number of the set of items to return. The default is 1." }, { "name": "filter", "value": "", "type": "query", "description": "An expression that lets you specify a subset of items to return. Use the format filter=field:operator:value. Operators include eq, gt, gte, lt, lte, has, and in." }, { "name": "sort", "value": "", "type": "query", "description": "An expression that lets you specify the order in which items are returned. Use the format sort=field:direction where direction is asc or desc." } ] }, "docs": "Returns a list of projects on the specified site, with optional pagination. You can filter and sort the list of projects." }, { "info": { "name": "Tableau Create Project", "type": "http" }, "http": { "method": "POST", "url": "https://{server}/api/{api-version}/sites/:site-id/projects", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a project on the specified site. You can also create project hierarchies by setting a parent project." }, { "info": { "name": "Tableau Update Project", "type": "http" }, "http": { "method": "PUT", "url": "https://{server}/api/{api-version}/sites/:site-id/projects/:project-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "project-id", "value": "", "type": "path", "description": "The ID of the project." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the name, description, or project hierarchy of the specified project." }, { "info": { "name": "Tableau Delete Project", "type": "http" }, "http": { "method": "DELETE", "url": "https://{server}/api/{api-version}/sites/:site-id/projects/:project-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "project-id", "value": "", "type": "path", "description": "The ID of the project." } ] }, "docs": "Deletes the specified project on a site. When you delete a project, all Tableau assets inside the project are also deleted." } ] }, { "info": { "name": "Workbooks", "type": "folder" }, "items": [ { "info": { "name": "Tableau Query Workbooks for Site", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/workbooks", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to return in one response. The minimum is 1 and the maximum is 1000." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number of the set of items to return. The default is 1." }, { "name": "filter", "value": "", "type": "query", "description": "An expression that lets you specify a subset of items to return. Use the format filter=field:operator:value. Operators include eq, gt, gte, lt, lte, has, and in." }, { "name": "sort", "value": "", "type": "query", "description": "An expression that lets you specify the order in which items are returned. Use the format sort=field:direction where direction is asc or desc." }, { "name": "fields", "value": "", "type": "query", "description": "An expression that lets you specify which fields are included in the response. Use the format fields=field1,field2. Use _default_ to return the default set of fields, or _all_ to return all fields." } ] }, "docs": "Returns the workbooks on a site. If the user is not an administrator, the method returns just the workbooks that the user has permissions to view." }, { "info": { "name": "Tableau Query Workbook", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "workbook-id", "value": "", "type": "path", "description": "The ID of the workbook." } ] }, "docs": "Returns information about the specified workbook, including information about views and tags." }, { "info": { "name": "Tableau Update Workbook", "type": "http" }, "http": { "method": "PUT", "url": "https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "workbook-id", "value": "", "type": "path", "description": "The ID of the workbook." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies an existing workbook, allowing you to change the owner, project, or other properties." }, { "info": { "name": "Tableau Delete Workbook", "type": "http" }, "http": { "method": "DELETE", "url": "https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "workbook-id", "value": "", "type": "path", "description": "The ID of the workbook." } ] }, "docs": "Deletes a workbook. When a workbook is deleted, all of its assets are also deleted, including associated views." }, { "info": { "name": "Tableau Query Workbook Connections", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/connections", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "workbook-id", "value": "", "type": "path", "description": "The ID of the workbook." } ] }, "docs": "Returns a list of data connections for the specified workbook." }, { "info": { "name": "Tableau Download Workbook", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/content", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "workbook-id", "value": "", "type": "path", "description": "The ID of the workbook." }, { "name": "extractValue", "value": "true", "type": "query", "description": "If true, and the workbook contains extracts, the download includes the extracts." } ] }, "docs": "Downloads a workbook in .twb or .twbx format. If the workbook contains extracts, the download is in .twbx format." }, { "info": { "name": "Tableau Query Workbook Preview Image", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/previewImage", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "workbook-id", "value": "", "type": "path", "description": "The ID of the workbook." } ] }, "docs": "Returns the thumbnail image for the specified workbook as a PNG file." }, { "info": { "name": "Tableau Publish Workbook", "type": "http" }, "http": { "method": "POST", "url": "https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/publish", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "overwrite", "value": "true", "type": "query", "description": "If true, overwrites an existing workbook with the same name in the same project." }, { "name": "skipConnectionCheck", "value": "true", "type": "query", "description": "If true, skips the connection check during publish." } ] }, "docs": "Publishes a workbook on the specified site. To make changes to an existing workbook, call Update Workbook or Publish Workbook with overwrite set to true." }, { "info": { "name": "Tableau Query Workbook Tags", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/tags", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "workbook-id", "value": "", "type": "path", "description": "The ID of the workbook." } ] }, "docs": "Returns a list of tags that have been added to the specified workbook." }, { "info": { "name": "Tableau Add Tags to Workbook", "type": "http" }, "http": { "method": "PUT", "url": "https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/tags", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "workbook-id", "value": "", "type": "path", "description": "The ID of the workbook." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds one or more tags to the specified workbook." }, { "info": { "name": "Tableau Delete Tag From Workbook", "type": "http" }, "http": { "method": "DELETE", "url": "https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/tags/:tag-name", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "workbook-id", "value": "", "type": "path", "description": "The ID of the workbook." }, { "name": "tag-name", "value": "example_value", "type": "path", "description": "The name of the tag to delete." } ] }, "docs": "Deletes a tag from the specified workbook." }, { "info": { "name": "Tableau Get Workbook Revisions", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/revisions", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "workbook-id", "value": "", "type": "path", "description": "The ID of the workbook." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to return in one response. The minimum is 1 and the maximum is 1000." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number of the set of items to return. The default is 1." } ] }, "docs": "Returns a list of revision information (revision number, published date, and other metadata) for each revision of the specified workbook." } ] }, { "info": { "name": "Views", "type": "folder" }, "items": [ { "info": { "name": "Tableau Query Views for Workbook", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/views", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "workbook-id", "value": "", "type": "path", "description": "The ID of the workbook." }, { "name": "includeUsageStatistics", "value": "true", "type": "query", "description": "If true, returns usage statistics for each view." } ] }, "docs": "Returns all the views for the specified workbook, optionally including usage statistics." }, { "info": { "name": "Tableau Query Views for Site", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/views", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to return in one response. The minimum is 1 and the maximum is 1000." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number of the set of items to return. The default is 1." }, { "name": "filter", "value": "", "type": "query", "description": "An expression that lets you specify a subset of items to return. Use the format filter=field:operator:value. Operators include eq, gt, gte, lt, lte, has, and in." }, { "name": "sort", "value": "", "type": "query", "description": "An expression that lets you specify the order in which items are returned. Use the format sort=field:direction where direction is asc or desc." }, { "name": "fields", "value": "", "type": "query", "description": "An expression that lets you specify which fields are included in the response. Use the format fields=field1,field2. Use _default_ to return the default set of fields, or _all_ to return all fields." }, { "name": "includeUsageStatistics", "value": "true", "type": "query", "description": "If true, returns usage statistics for each view." } ] }, "docs": "Returns all the views for the specified site, optionally including usage statistics." }, { "info": { "name": "Tableau Query View by Id", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/views/:view-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "view-id", "value": "", "type": "path", "description": "The ID of the view." } ] }, "docs": "Returns details about the specified view, including the view name, owner, project, and usage statistics." }, { "info": { "name": "Tableau Query View Image", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/views/:view-id/image", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "view-id", "value": "", "type": "path", "description": "The ID of the view." }, { "name": "resolution", "value": "standard", "type": "query", "description": "The resolution of the image (standard or high)." }, { "name": "maxAge", "value": "10", "type": "query", "description": "The maximum number of minutes a view image can be cached before being refreshed." }, { "name": "vf_", "value": "example_value", "type": "query", "description": "Apply a filter to the view. Replace with the name of the filter field." } ] }, "docs": "Returns an image of the specified view rendered as a PNG file. You can specify the resolution of the image." }, { "info": { "name": "Tableau Query View Data", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/views/:view-id/data", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "view-id", "value": "", "type": "path", "description": "The ID of the view." }, { "name": "maxAge", "value": "10", "type": "query", "description": "The maximum number of minutes a view can be cached before being refreshed." }, { "name": "vf_", "value": "example_value", "type": "query", "description": "Apply a filter to the view. Replace with the name of the filter field." } ] }, "docs": "Returns the data used in a view as a comma-separated values (CSV) file." }, { "info": { "name": "Tableau Query View Pdf", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/views/:view-id/pdf", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "view-id", "value": "", "type": "path", "description": "The ID of the view." }, { "name": "type", "value": "A3", "type": "query", "description": "The paper size for the PDF." }, { "name": "orientation", "value": "portrait", "type": "query", "description": "The orientation of the PDF." } ] }, "docs": "Returns a PDF rendering of the specified view." }, { "info": { "name": "Tableau Query View Preview Image", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/views/:view-id/previewImage", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "view-id", "value": "", "type": "path", "description": "The ID of the view." } ] }, "docs": "Returns the thumbnail image for the specified view as a PNG file." }, { "info": { "name": "Tableau Get Recommendations for Views", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/views/:view-id/recommendations", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "view-id", "value": "", "type": "path", "description": "The ID of the view." } ] }, "docs": "Returns a list of views that are recommended for a user, based on their viewing history." } ] }, { "info": { "name": "Data Sources", "type": "folder" }, "items": [ { "info": { "name": "Tableau Query Data Sources", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/datasources", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to return in one response. The minimum is 1 and the maximum is 1000." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number of the set of items to return. The default is 1." }, { "name": "filter", "value": "", "type": "query", "description": "An expression that lets you specify a subset of items to return. Use the format filter=field:operator:value. Operators include eq, gt, gte, lt, lte, has, and in." }, { "name": "sort", "value": "", "type": "query", "description": "An expression that lets you specify the order in which items are returned. Use the format sort=field:direction where direction is asc or desc." }, { "name": "fields", "value": "", "type": "query", "description": "An expression that lets you specify which fields are included in the response. Use the format fields=field1,field2. Use _default_ to return the default set of fields, or _all_ to return all fields." } ] }, "docs": "Returns a list of published data sources on the specified site, with optional pagination, filtering, and sorting." }, { "info": { "name": "Tableau Query Data Source", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "datasource-id", "value": "", "type": "path", "description": "The ID of the data source." } ] }, "docs": "Returns information about the specified data source." }, { "info": { "name": "Tableau Update Data Source", "type": "http" }, "http": { "method": "PUT", "url": "https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "datasource-id", "value": "", "type": "path", "description": "The ID of the data source." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the owner, project, or certification status of the specified data source." }, { "info": { "name": "Tableau Delete Data Source", "type": "http" }, "http": { "method": "DELETE", "url": "https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "datasource-id", "value": "", "type": "path", "description": "The ID of the data source." } ] }, "docs": "Deletes the specified data source from a site." }, { "info": { "name": "Tableau Download Data Source", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id/content", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "datasource-id", "value": "", "type": "path", "description": "The ID of the data source." }, { "name": "includeExtract", "value": "true", "type": "query", "description": "If true and the data source contains an extract, the download includes the extract." } ] }, "docs": "Downloads the specified data source in .tdsx format." }, { "info": { "name": "Tableau Query Data Source Connections", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id/connections", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "datasource-id", "value": "", "type": "path", "description": "The ID of the data source." } ] }, "docs": "Returns a list of data connections for the specified data source." }, { "info": { "name": "Tableau Get Data Source Revisions", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id/revisions", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "datasource-id", "value": "", "type": "path", "description": "The ID of the data source." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to return in one response. The minimum is 1 and the maximum is 1000." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number of the set of items to return. The default is 1." } ] }, "docs": "Returns a list of revision information for each revision of the specified data source." }, { "info": { "name": "Tableau Query Data Source Tags", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id/tags", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "datasource-id", "value": "", "type": "path", "description": "The ID of the data source." } ] }, "docs": "Returns a list of tags associated with the specified data source." }, { "info": { "name": "Tableau Add Tags to Data Source", "type": "http" }, "http": { "method": "PUT", "url": "https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id/tags", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "datasource-id", "value": "", "type": "path", "description": "The ID of the data source." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds one or more tags to the specified data source." }, { "info": { "name": "Tableau Query Data Source Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id/permissions", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "datasource-id", "value": "", "type": "path", "description": "The ID of the data source." } ] }, "docs": "Returns a list of permissions for the specified data source." }, { "info": { "name": "Tableau Add Data Source Permissions", "type": "http" }, "http": { "method": "PUT", "url": "https://{server}/api/{api-version}/sites/:site-id/datasources/:datasource-id/permissions", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "datasource-id", "value": "", "type": "path", "description": "The ID of the data source." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds permissions to the specified data source for a user or group." } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Tableau Get Users on Site", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/users", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to return in one response. The minimum is 1 and the maximum is 1000." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number of the set of items to return. The default is 1." }, { "name": "filter", "value": "", "type": "query", "description": "An expression that lets you specify a subset of items to return. Use the format filter=field:operator:value. Operators include eq, gt, gte, lt, lte, has, and in." }, { "name": "sort", "value": "", "type": "query", "description": "An expression that lets you specify the order in which items are returned. Use the format sort=field:direction where direction is asc or desc." } ] }, "docs": "Returns the users associated with the specified site." }, { "info": { "name": "Tableau Add User to Site", "type": "http" }, "http": { "method": "POST", "url": "https://{server}/api/{api-version}/sites/:site-id/users", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a user to the specified site. The user must already exist on the server or in the identity store." }, { "info": { "name": "Tableau Query User on Site", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/users/:user-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "user-id", "value": "", "type": "path", "description": "The ID of the user." } ] }, "docs": "Returns information about the specified user on the site." }, { "info": { "name": "Tableau Update User", "type": "http" }, "http": { "method": "PUT", "url": "https://{server}/api/{api-version}/sites/:site-id/users/:user-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "user-id", "value": "", "type": "path", "description": "The ID of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies information about the specified user." }, { "info": { "name": "Tableau Remove User From Site", "type": "http" }, "http": { "method": "DELETE", "url": "https://{server}/api/{api-version}/sites/:site-id/users/:user-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "user-id", "value": "", "type": "path", "description": "The ID of the user." } ] }, "docs": "Removes the specified user from the site." }, { "info": { "name": "Tableau Query Workbooks for User", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/users/:user-id/workbooks", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "user-id", "value": "", "type": "path", "description": "The ID of the user." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to return in one response. The minimum is 1 and the maximum is 1000." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number of the set of items to return. The default is 1." } ] }, "docs": "Returns the workbooks that the specified user owns or has Read (view) permissions for." } ] }, { "info": { "name": "Groups", "type": "folder" }, "items": [ { "info": { "name": "Tableau Query Groups", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/groups", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to return in one response. The minimum is 1 and the maximum is 1000." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number of the set of items to return. The default is 1." }, { "name": "filter", "value": "", "type": "query", "description": "An expression that lets you specify a subset of items to return. Use the format filter=field:operator:value. Operators include eq, gt, gte, lt, lte, has, and in." }, { "name": "sort", "value": "", "type": "query", "description": "An expression that lets you specify the order in which items are returned. Use the format sort=field:direction where direction is asc or desc." } ] }, "docs": "Returns a list of groups on the specified site." }, { "info": { "name": "Tableau Create Group", "type": "http" }, "http": { "method": "POST", "url": "https://{server}/api/{api-version}/sites/:site-id/groups", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a group on the specified site." }, { "info": { "name": "Tableau Update Group", "type": "http" }, "http": { "method": "PUT", "url": "https://{server}/api/{api-version}/sites/:site-id/groups/:group-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "group-id", "value": "", "type": "path", "description": "The ID of the group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the name or Active Directory configuration of the specified group." }, { "info": { "name": "Tableau Delete Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://{server}/api/{api-version}/sites/:site-id/groups/:group-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "group-id", "value": "", "type": "path", "description": "The ID of the group." } ] }, "docs": "Deletes the specified group from the site." }, { "info": { "name": "Tableau Get Group Members", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/groups/:group-id/users", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "group-id", "value": "", "type": "path", "description": "The ID of the group." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to return in one response. The minimum is 1 and the maximum is 1000." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number of the set of items to return. The default is 1." } ] }, "docs": "Returns a list of users who are members of the specified group." }, { "info": { "name": "Tableau Add User to Group", "type": "http" }, "http": { "method": "POST", "url": "https://{server}/api/{api-version}/sites/:site-id/groups/:group-id/users", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "group-id", "value": "", "type": "path", "description": "The ID of the group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a user to the specified group." }, { "info": { "name": "Tableau Remove User From Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://{server}/api/{api-version}/sites/:site-id/groups/:group-id/users/:user-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "group-id", "value": "", "type": "path", "description": "The ID of the group." }, { "name": "user-id", "value": "", "type": "path", "description": "The ID of the user." } ] }, "docs": "Removes the specified user from the specified group." } ] }, { "info": { "name": "Permissions", "type": "folder" }, "items": [ { "info": { "name": "Tableau Query Workbook Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/permissions", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "workbook-id", "value": "", "type": "path", "description": "The ID of the workbook." } ] }, "docs": "Returns a list of permissions for the specified workbook." }, { "info": { "name": "Tableau Add Workbook Permissions", "type": "http" }, "http": { "method": "PUT", "url": "https://{server}/api/{api-version}/sites/:site-id/workbooks/:workbook-id/permissions", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "workbook-id", "value": "", "type": "path", "description": "The ID of the workbook." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds permissions to the specified workbook for a user or group." }, { "info": { "name": "Tableau Query Default Permissions for Workbooks", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/projects/:project-id/default-permissions/workbooks", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "project-id", "value": "", "type": "path", "description": "The ID of the project." } ] }, "docs": "Returns the default permissions for workbooks in the specified project." } ] }, { "info": { "name": "Schedules", "type": "folder" }, "items": [ { "info": { "name": "Tableau Query Schedules", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/schedules", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to return in one response. The minimum is 1 and the maximum is 1000." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number of the set of items to return. The default is 1." } ] }, "docs": "Returns a list of extract refresh and subscription schedules. This method is available on Tableau Server only." } ] }, { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Tableau Query Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/subscriptions", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to return in one response. The minimum is 1 and the maximum is 1000." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number of the set of items to return. The default is 1." } ] }, "docs": "Returns a list of all subscriptions on the site." }, { "info": { "name": "Tableau Create Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://{server}/api/{api-version}/sites/:site-id/subscriptions", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new subscription to a view or workbook for the specified user on the specified schedule." }, { "info": { "name": "Tableau Query Subscription", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/subscriptions/:subscription-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "subscription-id", "value": "500123", "type": "path", "description": "The ID of the subscription." } ] }, "docs": "Returns information about the specified subscription." }, { "info": { "name": "Tableau Update Subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://{server}/api/{api-version}/sites/:site-id/subscriptions/:subscription-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "subscription-id", "value": "500123", "type": "path", "description": "The ID of the subscription to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies an existing subscription, changing the subject, schedule, or whether the full workbook or just a single view is sent." }, { "info": { "name": "Tableau Delete Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://{server}/api/{api-version}/sites/:site-id/subscriptions/:subscription-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "subscription-id", "value": "500123", "type": "path", "description": "The ID of the subscription to delete." } ] }, "docs": "Deletes the specified subscription from the site." } ] }, { "info": { "name": "Jobs", "type": "folder" }, "items": [ { "info": { "name": "Tableau Query Jobs", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/jobs", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of items to return in one response. The minimum is 1 and the maximum is 1000." }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number of the set of items to return. The default is 1." }, { "name": "filter", "value": "", "type": "query", "description": "An expression that lets you specify a subset of items to return. Use the format filter=field:operator:value. Operators include eq, gt, gte, lt, lte, has, and in." } ] }, "docs": "Returns a list of active jobs on the specified site." }, { "info": { "name": "Tableau Query Job", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/jobs/:job-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "job-id", "value": "500123", "type": "path", "description": "The ID of the job." } ] }, "docs": "Returns status information about the specified job." }, { "info": { "name": "Tableau Cancel Job", "type": "http" }, "http": { "method": "PUT", "url": "https://{server}/api/{api-version}/sites/:site-id/jobs/:job-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "job-id", "value": "500123", "type": "path", "description": "The ID of the job to cancel." } ] }, "docs": "Cancels the specified background job on a site." } ] }, { "info": { "name": "Favorites", "type": "folder" }, "items": [ { "info": { "name": "Tableau Get Favorites for User", "type": "http" }, "http": { "method": "GET", "url": "https://{server}/api/{api-version}/sites/:site-id/favorites/:user-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "user-id", "value": "", "type": "path", "description": "The ID of the user." } ] }, "docs": "Returns a list of favorite items for the specified user." }, { "info": { "name": "Tableau Add Favorites", "type": "http" }, "http": { "method": "PUT", "url": "https://{server}/api/{api-version}/sites/:site-id/favorites/:user-id", "params": [ { "name": "site-id", "value": "", "type": "path", "description": "The ID of the site. You can get the site ID from the response to the Sign In method." }, { "name": "user-id", "value": "", "type": "path", "description": "The ID of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified content to a user's favorites. You can add workbooks, views, data sources, projects, and flows." } ] } ], "bundled": true }