--- openapi: "3.0.1" info: title: "Tableau Services APIs" description: "Open API specification for Tableau Services APIs" version: "latest" paths: /api/-/pulse/metrics/{metric_id}/tag/{tag_id}: delete: tags: - "Metric Query" summary: "Deletes the tag given the tag_id" description: "This endpoint takes the tag_id and deletes the corresponding tag\ \ for the user." operationId: "MetricQueryService_DeleteTag" parameters: - name: "metric_id" in: "path" required: true schema: type: "string" - $ref: "#/components/parameters/tableau.auth.header" - name: "referrer" in: "query" description: "" required: false schema: type: "string" description: "" - name: "tag_id" in: "path" required: true schema: type: "string" responses: default: description: "Empty Response Body" /api/-/eventservice/publishUIEvent: post: tags: - "Event Stream" summary: "Publish a UI event." description: "Publish a UI event on the Pulse Event Stream." operationId: "EventService_PublishUIEvent" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.eventservice.v1.PublishUIEventRequest+json: schema: $ref: "#/components/schemas/tableau.eventservice.v1.PublishUIEventRequest" responses: default: description: "Successful." content: application/vnd.tableau.eventservice.v1.PublishUIEventResponse+json: schema: $ref: "#/components/schemas/tableau.eventservice.v1.PublishUIEventResponse" "201": description: "Successful." content: application/vnd.tableau.eventservice.v1.PublishUIEventResponse+json: schema: $ref: "#/components/schemas/tableau.eventservice.v1.PublishUIEventResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/authn-service/auth-configurations/: get: tags: - "AuthConfigurations" summary: "List Authentication Configurations" description: "List information about all authentication instances.\n\n > **Version:**\ \ Available in API 3.19 (Tableau Server 2023.1) and later. Not available in\ \ Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Can only be called by users with server administrator\ \ permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm)\ \ | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*" operationId: "AuthnService_ListAuthConfigurations" parameters: - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.authn.v1.ListAuthConfigurationsResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.ListAuthConfigurationsResponse" "200": description: "Successful." content: application/vnd.tableau.authn.v1.ListAuthConfigurationsResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.ListAuthConfigurationsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" post: tags: - "AuthConfigurations" summary: "Create Authentication Configuration" description: "Create an instance of OpenID Connect (OIDC) authentication.\n\n\ \ For more information, see [Step 3: Set up authentication](https://help.tableau.com/current/server/en-us/identity_pools_manage.htm#step3)\ \ in the Tableau Server Help.\n\n > **Version:** Available in API 3.19 (Tableau\ \ Server 2023.1) and later. Not available in Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Can only be called by users with server administrator\ \ permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm)\ \ | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*" operationId: "AuthnService_RegisterAuthConfiguration" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.authn.v1.RegisterAuthConfigurationRequest+json: schema: $ref: "#/components/schemas/tableau.authn.v1.RegisterAuthConfigurationRequest" responses: default: description: "Successful." content: application/vnd.tableau.authn.v1.RegisterAuthConfigurationResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.RegisterAuthConfigurationResponse" "201": description: "Successful." content: application/vnd.tableau.authn.v1.RegisterAuthConfigurationResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.RegisterAuthConfigurationResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/entitlements: get: tags: - "Metric Query" summary: "Get site entitlements" description: "Returns entitlments available for a site.If entitlments are True,\ \ then Pulse premium features are enabled for the site." operationId: "MetricQueryService_GetEntitlements" parameters: - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.GetEntitlementsResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.GetEntitlementsResponse" "200": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.GetEntitlementsResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.GetEntitlementsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/definitions/{definition_id}/permissions:add: post: tags: - "Definition Permissions" summary: "Add definition permission records to the definition specified by the\ \ id." description: "Add definition permission records on the definition" operationId: "PermissionService_AddDefinitionPermissions" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "definition_id" in: "path" required: true schema: type: "string" requestBody: content: application/vnd.tableau.permissionservice.v1.AddDefinitionPermissionsRequest+json: schema: $ref: "#/components/schemas/tableau.permissionservice.v1.AddDefinitionPermissionsRequest" responses: default: description: "Successful." content: application/vnd.tableau.permissionservice.v1.AddDefinitionPermissionsResponse+json: schema: $ref: "#/components/schemas/tableau.permissionservice.v1.AddDefinitionPermissionsResponse" "201": description: "Successful." content: application/vnd.tableau.permissionservice.v1.AddDefinitionPermissionsResponse+json: schema: $ref: "#/components/schemas/tableau.permissionservice.v1.AddDefinitionPermissionsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/definitions/{definition_id}/permissions:delete: post: tags: - "Definition Permissions" summary: "Delete definition permission records from the definition specified\ \ by the id." description: "Delete definition permission records on the definition" operationId: "PermissionService_DeleteDefinitionPermissions" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "definition_id" in: "path" required: true schema: type: "string" requestBody: content: application/vnd.tableau.permissionservice.v1.DeleteDefinitionPermissionsRequest+json: schema: $ref: "#/components/schemas/tableau.permissionservice.v1.DeleteDefinitionPermissionsRequest" responses: default: description: "Successful." content: application/vnd.tableau.permissionservice.v1.DeleteDefinitionPermissionsResponse+json: schema: $ref: "#/components/schemas/tableau.permissionservice.v1.DeleteDefinitionPermissionsResponse" "201": description: "Successful." content: application/vnd.tableau.permissionservice.v1.DeleteDefinitionPermissionsResponse+json: schema: $ref: "#/components/schemas/tableau.permissionservice.v1.DeleteDefinitionPermissionsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/content/usage-stats/{type}/{luid}: get: tags: - "Usage Statistics" summary: "Get usage statistics for content item" description: "Gets the usage statistics for a Tableau content item, specified\ \ by LUID and content type, such as workbook, datasource, or flow." operationId: "UsageStatsService_GetUsageStats" parameters: - name: "type" in: "path" required: true schema: type: "string" description: "The content type of the kind of resource being specified,\ \ for instance: `workbooks`, `flows`, and `datasources`." - $ref: "#/components/parameters/tableau.auth.header" - name: "luid" in: "path" required: true schema: type: "string" responses: default: description: "Successful." content: application/vnd.tableau.usagestats.v1.UsageStats+json: schema: $ref: "#/components/schemas/tableau.usagestats.v1.UsageStats" "200": description: "Successful." content: application/vnd.tableau.usagestats.v1.UsageStats+json: schema: $ref: "#/components/schemas/tableau.usagestats.v1.UsageStats" "400": description: "Usage statistics are not supported for the provided content\ \ type." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Invalid request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/insights/breakdown: post: tags: - "Metric Insights" summary: "Generate breakdown insight bundle" description: "Generates a breakdown insight bundle. This provides the BAN and\ \ breakdown groups of insights." operationId: "PulseInsightsService_GenerateInsightBundleBreakdown" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleBreakdownRequest+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleBreakdownRequest" responses: default: description: "Successful." content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleBreakdownResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleBreakdownResponse" "201": description: "Successful." content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleBreakdownResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleBreakdownResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/subscriptions: get: tags: - "Subscriptions" summary: "Lists the subscriptions available on a server." description: "Lists the subscriptions available on a server. Only subscriptions\ \ a user has privileges to view will be visible." operationId: "PulseSubscriptionService_ListSubscriptions" parameters: - name: "page_token" in: "query" description: "Specifies the page of items to be returned from a requested\ \ list. The value of `page_token` for the next page of returns is found\ \ in the `next_page_token` of the current response. If there are no further\ \ items to return, the value of `next_page_token` will be empty.\n\nExample:\n\ \n> `GET ...//subscriptions?pageToken={next_page_value}`\nCombining Path\ \ Parameters:\n\nA page_token expression can be combined with other path\ \ parameters using an ampersand (&) as a separator, and is typically used\ \ along with a page number expression.\n\n\nLearn more about paginating the response." required: false schema: type: "string" description: "" - name: "user_id" in: "query" description: "" required: false schema: type: "string" description: "" - name: "page_size" in: "query" description: "Specifies the number of results in a paged response.\n\n\nExample:\n\ \n\n> `GET ...//subscriptions?pageSize=50`\n\n\nCombining Path Parameters:\n\ \nA page_size expression can be combined with other path parameters using\ \ an ampersand (&) as a separator, and is typically used along with a page\ \ number expression.\n\n\nLearn more about paginating the response." required: false schema: type: "integer" description: "" format: "int32" - $ref: "#/components/parameters/tableau.auth.header" - name: "metric_id" in: "query" description: "" required: false schema: type: "string" description: "" responses: default: description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.ListSubscriptionsResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.ListSubscriptionsResponse" "200": description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.ListSubscriptionsResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.ListSubscriptionsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" post: tags: - "Subscriptions" summary: "Creates a subscription." description: "Creates a subscription." operationId: "PulseSubscriptionService_CreateSubscription" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.pulse.subscriptionservice.v1.CreateSubscriptionRequest+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.CreateSubscriptionRequest" responses: default: description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.CreateSubscriptionResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.CreateSubscriptionResponse" "201": description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.CreateSubscriptionResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.CreateSubscriptionResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/askdata/lenses/{lens_id}: get: tags: - "AskDataLenses" summary: "Get ask data lens details" description: "Get the details of a lens. Permissions - This method can be called\ \ by users who have read access to the lens." operationId: "LensService_getLens" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "lens_id" in: "path" required: true schema: type: "string" description: "Id of the lens" responses: default: description: "Successful." content: application/vnd.tableau.nlp.lens.publicrest.v1.GetLensResponse+json: schema: $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.GetLensResponse" "200": description: "Successful." content: application/vnd.tableau.nlp.lens.publicrest.v1.GetLensResponse+json: schema: $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.GetLensResponse" "400": description: "invalid lens id (luid)" content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "internal database exception" content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "datasource not found" content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" delete: tags: - "AskDataLenses" summary: "Delete a lens" description: "Delete an Ask Data lens. Permissions- This can be invoked by a\ \ user who has permission to delete a lens." operationId: "LensService_deleteLens" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "lens_id" in: "path" required: true schema: type: "string" description: "Id of the lens" responses: default: description: "Empty Response Body" /api/-/pulse/subscriptions:batchGetMetricFollowerCounts: get: tags: - "Subscriptions" summary: "Gets the total number of unique followers per metric" description: "Calculates the number of unique followers for list of metrics.\ \ For metrics that have group followers the count will be the union of all\ \ the members of the subscribed groups plus all the individual followers.\ \ Users are counted only once per metric." operationId: "PulseSubscriptionService_BatchGetMetricFollowerCounts" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "metric_ids" in: "query" description: "" required: false schema: type: "string" description: "" responses: default: description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.BatchGetMetricFollowerCountsResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.BatchGetMetricFollowerCountsResponse" "200": description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.BatchGetMetricFollowerCountsResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.BatchGetMetricFollowerCountsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/metrics:getOrCreate: post: tags: - "Metric Definitions" summary: "Creates a metric and returns boolean indicating whether the new metric\ \ was created or not." description: "Creates a metric and returns boolean indicating whether the new\ \ metric was created or not." operationId: "MetricQueryService_GetOrCreateMetric" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.metricqueryservice.v1.GetOrCreateMetricRequest+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.GetOrCreateMetricRequest" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.GetOrCreateMetricResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.GetOrCreateMetricResponse" "201": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.GetOrCreateMetricResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.GetOrCreateMetricResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/metrics:followedMetricsGroups: get: tags: - "Metric Definitions" summary: "List followed metrics groups" description: "Gets the user's followed metrics. Optionally metrics can be grouped\ \ by characteristics like datasource, and sorted. If no grouping and sorting\ \ is specified then returns are grouped and sorted by existing user preferences.\ \ If no user preferences exist or are specified, then metrics are grouped\ \ by most recently followed, in descending order. If metrics are grouped by\ \ most recently followed then they are returned in a single group, that is\ \ sorted by the specified, existing, or default order." operationId: "PulseSubscriptionService_ListFollowedMetricsGroups" parameters: - name: "group_by" in: "query" description: "" required: false schema: type: "string" description: "" enum: - "GROUP_BY_UNSPECIFIED" - "GROUP_BY_RECENTLY_FOLLOWED" - "GROUP_BY_DEFINITION_NAME" - "GROUP_BY_DATASOURCE_LABEL" - "GROUP_BY_TIME_RANGE" - $ref: "#/components/parameters/tableau.auth.header" - name: "sort_order" in: "query" description: "" required: false schema: type: "string" description: "" enum: - "SORT_ORDER_UNSPECIFIED" - "SORT_ORDER_ASCENDING" - "SORT_ORDER_DESCENDING" responses: default: description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.ListFollowedMetricsGroupsResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.ListFollowedMetricsGroupsResponse" "200": description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.ListFollowedMetricsGroupsResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.ListFollowedMetricsGroupsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/insights/ban: post: tags: - "Metric Insights" summary: "Generates a BAN insight bundle." description: "Generates a BAN insight bundle." operationId: "PulseInsightsService_GenerateInsightBundleBAN" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleBANRequest+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleBANRequest" responses: default: description: "Successful." content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleBANResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleBANResponse" "201": description: "Successful." content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleBANResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleBANResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/metrics/{metric_id}/tag: post: tags: - "Metric Query" summary: "Creates a tag associated with the given metric and/or the user." description: "Creates a tag associated with the given metric_id and optionally\ \ the user.The endpoint takes the category (user or system defined tag) and\ \ the tag value. Value for a user defined tag can be any string given by the\ \ user. System defined tags are one of the predefined values like mute-from-summary\ \ and are only applied to the user creating the tag. The endpoint returns\ \ the metadata of the tag that was created." operationId: "MetricQueryService_CreateTag" parameters: - name: "metric_id" in: "path" required: true schema: type: "string" - $ref: "#/components/parameters/tableau.auth.header" - name: "referrer" in: "query" description: "" required: false schema: type: "string" description: "" requestBody: content: application/vnd.tableau.metricqueryservice.v1.CreateTagRequest+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.CreateTagRequest" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.CreateTagResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.CreateTagResponse" "201": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.CreateTagResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.CreateTagResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/insights/exploration: post: tags: - "Metric Insights" summary: "Generate exploration insight bundle" description: "Generates an exploration insight bundle. This provides the BAN,\ \ anchor, and followup groups of insights." operationId: "PulseInsightsService_GenerateInsightBundleExploration" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleExplorationRequest+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleExplorationRequest" responses: default: description: "Successful." content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleExplorationResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleExplorationResponse" "201": description: "Successful." content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleExplorationResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleExplorationResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/definitions/{definition_id}/permissions: get: tags: - "Definition Permissions" summary: "Get definition permission records for the definition specified by\ \ the id." description: "Get all definition permission records on the definition" operationId: "PermissionService_GetDefinitionPermissions" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "definition_id" in: "path" required: true schema: type: "string" responses: default: description: "Successful." content: application/vnd.tableau.permissionservice.v1.GetDefinitionPermissionsResponse+json: schema: $ref: "#/components/schemas/tableau.permissionservice.v1.GetDefinitionPermissionsResponse" "200": description: "Successful." content: application/vnd.tableau.permissionservice.v1.GetDefinitionPermissionsResponse+json: schema: $ref: "#/components/schemas/tableau.permissionservice.v1.GetDefinitionPermissionsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/definitions/validation: post: tags: - "Metric Definitions" summary: "Validates a metric definition." description: "Validates a metric definition." operationId: "MetricQueryService_ValidateDefinition" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.metricqueryservice.v1.ValidateDefinitionRequest+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.ValidateDefinitionRequest" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.ValidateDefinitionResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.ValidateDefinitionResponse" "201": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.ValidateDefinitionResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.ValidateDefinitionResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/metrics:recommended: get: tags: - "Metric Definitions" summary: "Gets recommended metrics" description: "Gets personalized groups of metrics to recommend to a user. Only\ \ metric that the user has privileges to view will be returned" operationId: "PulseSubscriptionService_GetRecommendedMetrics" parameters: - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.GetRecommendedMetricsResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.GetRecommendedMetricsResponse" "200": description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.GetRecommendedMetricsResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.GetRecommendedMetricsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/alerts: get: tags: - "Metric Query" summary: "List site alerts" description: "Returns a list of alerts for the user on this site." operationId: "AlertService_ListAlerts" parameters: - name: "page_token" in: "query" description: "Specifies the page of items to be returned from a requested\ \ list. The value of `page_token` for the next page of returns is found\ \ in the `next_page_token` of the current response. If there are no further\ \ items to return, the value of `next_page_token` will be empty.\n\nExample:\n\ \n> `GET ...//alerts?pageToken={next_page_value}`\nCombining Path Parameters:\n\ \nA page_token expression can be combined with other path parameters using\ \ an ampersand (&) as a separator, and is typically used along with a page\ \ number expression.\n\n\nLearn more about paginating the response." required: false schema: type: "string" description: "" - $ref: "#/components/parameters/tableau.auth.header" - name: "after" in: "query" description: "" required: false schema: type: "string" description: "" - name: "page_size" in: "query" description: "Specifies the number of results in a paged response.\n\n\nExample:\n\ \n\n> `GET ...//alerts?pageSize=50`\n\n\nCombining Path Parameters:\n\n\ A page_size expression can be combined with other path parameters using\ \ an ampersand (&) as a separator, and is typically used along with a page\ \ number expression.\n\n\nLearn more about paginating the response." required: false schema: type: "integer" description: "" format: "int32" responses: default: description: "Successful." content: application/vnd.tableau.alertservice.v1.ListAlertsResponse+json: schema: $ref: "#/components/schemas/tableau.alertservice.v1.ListAlertsResponse" "200": description: "Successful." content: application/vnd.tableau.alertservice.v1.ListAlertsResponse+json: schema: $ref: "#/components/schemas/tableau.alertservice.v1.ListAlertsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/askdata/lenses/import: post: tags: - "AskDataLenses" summary: "Import a lens" description: "This API lets you import a lens in to the site. Useful when you\ \ want to publish a lens across projects, sites etc. The input to this API\ \ is a lens that already exist in a server. You can get the details of the\ \ lens using the getLens method and submit to this method. During an import,\ \ you can use transformations to apply on the exported lens. Permissions -\ \ This method can only be called by server administrators or site administrators." operationId: "LensService_importLens" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.nlp.lens.publicrest.v1.ImportLensRequest+json: schema: $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.ImportLensRequest" responses: default: description: "Successful." content: application/vnd.tableau.nlp.lens.publicrest.v1.ImportLensResponse+json: schema: $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.ImportLensResponse" "201": description: "Successful." content: application/vnd.tableau.nlp.lens.publicrest.v1.ImportLensResponse+json: schema: $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.ImportLensResponse" "400": description: "invalid datasource id" content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "only system admin or site admin can use this method" content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "exception from permission service" content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "datasource not found" content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/definitions/{definition_id}/metrics: get: tags: - "Metric Definitions" summary: "Lists the metrics available on a server." description: "Lists the metrics based on a metric definition. Only metrics a\ \ user has privileges to view will be visible." operationId: "MetricQueryService_ListMetrics" parameters: - name: "page_size" in: "query" description: "Specifies the number of results in a paged response.\n\n\nExample:\n\ \n\n> `GET ...//definitions/{definition_id}/metrics?pageSize=50`\n\n\nCombining\ \ Path Parameters:\n\nA page_size expression can be combined with other\ \ path parameters using an ampersand (&) as a separator, and is typically\ \ used along with a page number expression.\n\n\nLearn more about paginating the response." required: false schema: type: "integer" description: "" format: "int32" - name: "page_token" in: "query" description: "Specifies the page of items to be returned from a requested\ \ list. The value of `page_token` for the next page of returns is found\ \ in the `next_page_token` of the current response. If there are no further\ \ items to return, the value of `next_page_token` will be empty.\n\nExample:\n\ \n> `GET ...//definitions/{definition_id}/metrics?pageToken={next_page_value}`\n\ Combining Path Parameters:\n\nA page_token expression can be combined with\ \ other path parameters using an ampersand (&) as a separator, and is typically\ \ used along with a page number expression.\n\n\nLearn more about paginating the response." required: false schema: type: "string" description: "" - name: "enable_sorting" in: "query" description: "" required: false schema: type: "boolean" description: "" - name: "order_by" in: "query" description: "" required: false schema: type: "string" description: "" - $ref: "#/components/parameters/tableau.auth.header" - name: "exclude_metrics_without_followers" in: "query" description: "" required: false schema: type: "boolean" description: "" - name: "definition_id" in: "path" required: true schema: type: "string" - name: "filter" in: "query" description: "" required: false schema: type: "string" description: "" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.ListMetricsResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.ListMetricsResponse" "200": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.ListMetricsResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.ListMetricsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/settings/server/extensions/analytics: get: tags: - "Settings" summary: "Get enabled state of analytics extensions on server" description: "Gets the enabled/disabled state of analytics extensions on a server.\ \ Permissions - This method can only be called by server administrators." operationId: "AnalyticsExtensionsService_getAnalyticsExtensionsServerSettings" parameters: - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ServerSettings+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ServerSettings" "200": description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ServerSettings+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ServerSettings" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" put: tags: - "Settings" summary: "Enable/disable analytics extensions on server" description: "Enables or disables analytics extensions on a server. Permissions\ \ - This method can only be called by server administrators." operationId: "AnalyticsExtensionsService_updateAnalyticsExtensionsServerSettings" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.analyticsextensions.v1.ServerSettings+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ServerSettings" responses: default: description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ServerSettings+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ServerSettings" "200": description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ServerSettings+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ServerSettings" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/metrics: post: tags: - "Metric Definitions" summary: "Creates a metric." description: "Creates a metric." operationId: "MetricQueryService_CreateMetric" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.metricqueryservice.v1.CreateMetricRequest+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.CreateMetricRequest" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.CreateMetricResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.CreateMetricResponse" "201": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.CreateMetricResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.CreateMetricResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/definitions/{definition_id}/permissions:hasEffectivePermissions: get: tags: - "Definition Permissions" summary: "Based on the site role and other rules get the effective permissions\ \ of the current user" description: "Get effective permissions of the current user" operationId: "PermissionService_HasEffectivePermissions" parameters: - name: "permissions" in: "query" description: "" required: false schema: type: "string" description: "" - $ref: "#/components/parameters/tableau.auth.header" - name: "definition_id" in: "path" required: true schema: type: "string" responses: default: description: "Successful." content: application/vnd.tableau.permissionservice.v1.HasEffectivePermissionsResponse+json: schema: $ref: "#/components/schemas/tableau.permissionservice.v1.HasEffectivePermissionsResponse" "200": description: "Successful." content: application/vnd.tableau.permissionservice.v1.HasEffectivePermissionsResponse+json: schema: $ref: "#/components/schemas/tableau.permissionservice.v1.HasEffectivePermissionsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/subscriptions:batchCreate: post: tags: - "Subscriptions" summary: "Creates multiple subscriptions." description: "Creates multiple subscriptions." operationId: "PulseSubscriptionService_BatchCreateSubscriptions" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.pulse.subscriptionservice.v1.BatchCreateSubscriptionsRequest+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.BatchCreateSubscriptionsRequest" responses: default: description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.BatchCreateSubscriptionsResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.BatchCreateSubscriptionsResponse" "201": description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.BatchCreateSubscriptionsResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.BatchCreateSubscriptionsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/settings/site/extensions/analytics/workbooks/{workbook_luid}/selected_connection: get: tags: - "Settings" summary: "Get current analytics extension for workbook" description: "Gets basic details, including connection type and name, of the\ \ analytics extension connection to an external service that the specified\ \ workbook is currently using. Permissions - This method can be called by\ \ users with authoring access to the workbook." operationId: "AnalyticsExtensionsService_getSelectedConnectionForWorkbook" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "workbook_luid" in: "path" required: true schema: type: "string" responses: default: description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ConnectionMetadata+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionMetadata" "200": description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ConnectionMetadata+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionMetadata" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" put: tags: - "Settings" summary: "Update analytics extension for workbook" description: "Updates the analytics extension connection to external service\ \ currently used by a workbook. Permissions - This method can be called by\ \ users that have permissions to the specified workbook." operationId: "AnalyticsExtensionsService_updateWorkbookWithConnection" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "workbook_luid" in: "path" required: true schema: type: "string" requestBody: content: application/vnd.tableau.analyticsextensions.v1.ConnectionMapping+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionMapping" responses: default: description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ConnectionMapping+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionMapping" "200": description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ConnectionMapping+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionMapping" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" delete: tags: - "Settings" summary: "Remove current analytics extension connection for workbook" description: "Remove the currently used analytics extension connection to an\ \ external service from the specified workbook. The connection remains configured,\ \ and is available for further usage by the workbook. Permissions - This method\ \ can be called by users with authoring access to the workbook." operationId: "AnalyticsExtensionsService_deleteConnectionFromWorkbook" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "workbook_luid" in: "path" required: true schema: type: "string" responses: default: description: "Empty Response Body" /api/-/authn-service/identity-stores/{id}: delete: tags: - "IdentityStore" summary: "Delete Identity Store" description: "Delete an identity store.\n\n **Note:** You cannot delete the\ \ identity store you configured during Tableau Server setup.\n\n > **Version:**\ \ Available in API 3.19 (Tableau Server 2023.1) and later. Not available in\ \ Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Can only be called by users with server administrator\ \ permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm)\ \ | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*" operationId: "AuthnService_DeleteIdentityStoreTAG" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "id" in: "path" required: true schema: type: "integer" description: "Required. Identity store ID." format: "int32" responses: default: description: "Empty Response Body" /api/-/pulse/subscriptions/{id}: get: tags: - "Subscriptions" summary: "Gets a subscription based on the specified id." description: "Gets a subscription." operationId: "PulseSubscriptionService_GetSubscription" parameters: - name: "id" in: "path" required: true schema: type: "string" - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.GetSubscriptionResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.GetSubscriptionResponse" "200": description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.GetSubscriptionResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.GetSubscriptionResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" delete: tags: - "Subscriptions" summary: "Deletes a subscription." description: "Deletes a subscription." operationId: "PulseSubscriptionService_DeleteSubscription" parameters: - name: "id" in: "path" required: true schema: type: "string" - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Empty Response Body" patch: tags: - "Subscriptions" summary: "Updates a subscription." description: "Updates a subscription." operationId: "PulseSubscriptionService_UpdateSubscription" parameters: - name: "id" in: "path" required: true schema: type: "string" - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.pulse.subscriptionservice.v1.UpdateSubscriptionRequest+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.UpdateSubscriptionRequest" responses: default: description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.UpdateSubscriptionResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.UpdateSubscriptionResponse" "200": description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.UpdateSubscriptionResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.UpdateSubscriptionResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/authn-service/identity-stores/: get: tags: - "IdentityStore" summary: "List Identity Stores" description: "List information about all identity store instances used to provision\ \ users.\n\n > **Version:** Available in API 3.19 (Tableau Server 2023.1)\ \ and later. Not available in Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Can only be called by users with server administrator\ \ permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm)\ \ | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*" operationId: "AuthnService_ListIdentityStoresTAG" parameters: - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.authn.v1.ListIdentityStoresResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.ListIdentityStoresResponse" "200": description: "Successful." content: application/vnd.tableau.authn.v1.ListIdentityStoresResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.ListIdentityStoresResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" post: tags: - "IdentityStore" summary: "Configure Identity Store" description: "Configure a new local identity store to provision users.\n\n For\ \ more information, see [Step 2: Set up an identity store](https://help.tableau.com/current/server/en-us/identity_pools_manage.htm#step2)\ \ in the Tableau Server Help.\n\n **Note:** This identity store is in addition\ \ to the identity store you configured during Tableau Server setup.\n\n >\ \ **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not\ \ available in Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Can only be called by users with server administrator\ \ permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm)\ \ | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*" operationId: "AuthnService_RegisterIdentityStoreTAG" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.authn.v1.RegisterIdentityStoreRequest+json: schema: $ref: "#/components/schemas/tableau.authn.v1.RegisterIdentityStoreRequest" responses: default: description: "Successful." content: application/vnd.tableau.authn.v1.RegisterIdentityStoreResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.RegisterIdentityStoreResponse" "201": description: "Successful." content: application/vnd.tableau.authn.v1.RegisterIdentityStoreResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.RegisterIdentityStoreResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/user/digestpreferences: get: tags: - "Subscriptions" summary: "Get user digest preferences" description: "Gets the user's digest preferences for which delivery channels\ \ to receive notifications on, and at what cadence." operationId: "PulseSubscriptionService_GetUserDigestPreferences" parameters: - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.GetUserDigestPreferencesResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.GetUserDigestPreferencesResponse" "200": description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.GetUserDigestPreferencesResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.GetUserDigestPreferencesResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" patch: tags: - "Subscriptions" summary: "Update user digest preferences" description: "Updates the user's digest preferences for which delivery channels\ \ to receive notifications on, and at what cadence." operationId: "PulseSubscriptionService_UpdateUserDigestPreferences" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.pulse.subscriptionservice.v1.UpdateUserDigestPreferencesRequest+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.UpdateUserDigestPreferencesRequest" responses: default: description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.UpdateUserDigestPreferencesResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.UpdateUserDigestPreferencesResponse" "200": description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.UpdateUserDigestPreferencesResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.UpdateUserDigestPreferencesResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/metrics/{metric_id}: get: tags: - "Metric Definitions" summary: "Gets the metric by ID." description: "Gets the metric by its ID. User must have privileges to view the\ \ requested metric." operationId: "MetricQueryService_GetMetric" parameters: - name: "metric_id" in: "path" required: true schema: type: "string" - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.GetMetricResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.GetMetricResponse" "200": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.GetMetricResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.GetMetricResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" delete: tags: - "Metric Definitions" summary: "Deletes a metric." description: "Deletes a metric." operationId: "MetricQueryService_DeleteMetric" parameters: - name: "metric_id" in: "path" required: true schema: type: "string" - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Empty Response Body" patch: tags: - "Metric Definitions" summary: "Updates a metric." description: "Updates a metric." operationId: "MetricQueryService_UpdateMetric" parameters: - name: "metric_id" in: "path" required: true schema: type: "string" - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.metricqueryservice.v1.UpdateMetricRequest+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.UpdateMetricRequest" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.UpdateMetricResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.UpdateMetricResponse" "200": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.UpdateMetricResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.UpdateMetricResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/insights/basic: post: tags: - "Metric Insights" summary: "Generates a basic insight bundle." description: "Generates a basic insight bundle." operationId: "PulseInsightsService_GenerateInsightBundleBasic" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleBasicRequest+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleBasicRequest" responses: default: description: "Successful." content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleBasicResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleBasicResponse" "201": description: "Successful." content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleBasicResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleBasicResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/subscriptions:batchGet: get: tags: - "Subscriptions" summary: "Gets a batch of subscriptions available on a server." description: "Gets batches of subscriptions available on a server. Only subscriptions\ \ a user has privileges to view will be visible." operationId: "PulseSubscriptionService_BatchGetSubscriptions" parameters: - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.BatchGetSubscriptionsResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.BatchGetSubscriptionsResponse" "200": description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.BatchGetSubscriptionsResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.BatchGetSubscriptionsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/content/usage-stats: post: tags: - "Usage Statistics" summary: "Get batch usage statistics" description: "Gets usage statistics for multiple content items. The batch of\ \ can include multiple content types." operationId: "UsageStatsService_BatchGetUsage" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.usagestats.v1.BatchGetUsageRequest+json: schema: $ref: "#/components/schemas/tableau.usagestats.v1.BatchGetUsageRequest" responses: default: description: "Successful." content: application/vnd.tableau.usagestats.v1.ContentItemUsageStatsList+json: schema: $ref: "#/components/schemas/tableau.usagestats.v1.ContentItemUsageStatsList" "201": description: "Successful." content: application/vnd.tableau.usagestats.v1.ContentItemUsageStatsList+json: schema: $ref: "#/components/schemas/tableau.usagestats.v1.ContentItemUsageStatsList" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Invalid request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/askdata/lenses: get: tags: - "AskDataLenses" summary: "Get ask data lens list" description: "Returns a list of lenses in a site. Permissions - This method\ \ can be called by any user and they will see the lenses to which they have\ \ access to." operationId: "LensService_listLenses" parameters: - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.nlp.lens.publicrest.v1.ListLensesResponse+json: schema: $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.ListLensesResponse" "200": description: "Successful." content: application/vnd.tableau.nlp.lens.publicrest.v1.ListLensesResponse+json: schema: $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.ListLensesResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "failed to get list of lenses" content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" post: tags: - "AskDataLenses" summary: "Create a lens" description: "Create an ask data lens. Permissions- This can be invoked by a\ \ user who has permission to create lens." operationId: "LensService_createLens" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.nlp.lens.publicrest.v1.CreateLensRequest+json: schema: $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.CreateLensRequest" responses: default: description: "Successful." content: application/vnd.tableau.nlp.lens.publicrest.v1.CreateLensResponse+json: schema: $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.CreateLensResponse" "201": description: "Successful." content: application/vnd.tableau.nlp.lens.publicrest.v1.CreateLensResponse+json: schema: $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.CreateLensResponse" "400": description: "invalid datasource id" content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "exception from permission service" content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "datasource not found" content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/settings/site/extensions/analytics/workbooks/{workbook_luid}/connections: get: tags: - "Settings" summary: "List analytics extension connections of workbook" description: "Lists basic details of each analytics extension connection available\ \ for a specified workbook, including connection type and name. Permissions\ \ - This method can be called by users that have permissions to the specified\ \ workbook." operationId: "AnalyticsExtensionsService_getConnectionOptionsForWorkbook" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "workbook_luid" in: "path" required: true schema: type: "string" responses: default: description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ConnectionMetadataList+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionMetadataList" "200": description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ConnectionMetadataList+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionMetadataList" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/customdomains/settings/site/{site_luid}: get: tags: - "CustomDomains" summary: "Get custom domain settings" description: "Gets the custom domain settings for a Tableau site.\n\n > **Version:**\ \ Available in API 3.21 (Tableau Cloud October 2023) and later. Not available\ \ for Tableau Server. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Only users with administrator permissions can view\ \ a site's custom domain settings. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm)*" operationId: "CustomDomainsService_getSiteCustomDomainSettings" parameters: - name: "site_luid" in: "path" required: true schema: type: "string" description: "The LUID of the Tableau site." - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.customdomains.v1.SiteCustomDomainSettingsResponse+json: schema: $ref: "#/components/schemas/tableau.customdomains.v1.SiteCustomDomainSettingsResponse" "200": description: "Successful." content: application/vnd.tableau.customdomains.v1.SiteCustomDomainSettingsResponse+json: schema: $ref: "#/components/schemas/tableau.customdomains.v1.SiteCustomDomainSettingsResponse" "400": description: "The request was malformed." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "User could not be authenticated. Credentials were missing\ \ or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "An unknown error occured." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Tableau service was unavailable. Retry at a later time." content: application/json: schema: $ref: "#/components/schemas/tableau.error" put: tags: - "CustomDomains" summary: "Update custom domain settings" description: "Updates the custom\ \ domain setup for a Tableau site.
For more information, see [Setup Steps\ \ to Enable a Custom Domain](#setup_steps_to_enable_a_custom_domain).\n\n\ \ > **Version:** Available in API 3.21 (Tableau Cloud October 2023) and later.\ \ Not available for Tableau Server. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Only users with administrator permissions can update\ \ a site's custom domain settings. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm)*" operationId: "CustomDomainsService_updateSiteCustomDomainSettings" parameters: - name: "site_luid" in: "path" required: true schema: type: "string" description: "The LUID of the Tableau site associated with the custom domain." - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.customdomains.v1.SiteCustomDomainSettingsRequest+json: schema: $ref: "#/components/schemas/tableau.customdomains.v1.SiteCustomDomainSettingsRequest" responses: default: description: "Successful." content: application/vnd.tableau.customdomains.v1.SiteCustomDomainSettingsResponse+json: schema: $ref: "#/components/schemas/tableau.customdomains.v1.SiteCustomDomainSettingsResponse" "200": description: "Successful." content: application/vnd.tableau.customdomains.v1.SiteCustomDomainSettingsResponse+json: schema: $ref: "#/components/schemas/tableau.customdomains.v1.SiteCustomDomainSettingsResponse" "400": description: "The request was malformed." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "User could not be authenticated. Credentials were missing\ \ or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "An unknown error occured." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Tableau service was unavailable. Retry at a later time." content: application/json: schema: $ref: "#/components/schemas/tableau.error" post: tags: - "CustomDomains" summary: "Create custom domain settings" description: "Starts the process\ \ of custom domain setup for a Tableau site.
For more information, see\ \ [Setup Steps to Enable a Custom Domain](#setup_steps_to_enable_a_custom_domain).\n\ \n > **Version:** Available in API 3.21 (Tableau Cloud October 2023) and later.\ \ Not available for Tableau Server. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Only users with administrator permissions can create\ \ a custom domain for a site. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm)*" operationId: "CustomDomainsService_createSiteCustomDomainSettings" parameters: - name: "site_luid" in: "path" required: true schema: type: "string" description: "The LUID of the Tableau site associated with the custom domain." - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.customdomains.v1.SiteCustomDomainSettingsRequest+json: schema: $ref: "#/components/schemas/tableau.customdomains.v1.SiteCustomDomainSettingsRequest" responses: default: description: "Successful." content: application/vnd.tableau.customdomains.v1.SiteCustomDomainSettingsResponse+json: schema: $ref: "#/components/schemas/tableau.customdomains.v1.SiteCustomDomainSettingsResponse" "201": description: "Successful." content: application/vnd.tableau.customdomains.v1.SiteCustomDomainSettingsResponse+json: schema: $ref: "#/components/schemas/tableau.customdomains.v1.SiteCustomDomainSettingsResponse" "400": description: "The request was malformed." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "User could not be authenticated. Credentials were missing\ \ or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "An unknown error occured." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Tableau service was unavailable. Retry at a later time." content: application/json: schema: $ref: "#/components/schemas/tableau.error" delete: tags: - "CustomDomains" summary: "Delete custom domain settings" description: "Deletes the custom domain setup for a Tableau site.\n\n > **Version:**\ \ Available in API 3.21 (Tableau Cloud October 2023) and later. Not available\ \ for Tableau Server. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Only users with administrator permissions can view\ \ a site's custom domain settings. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm)*" operationId: "CustomDomainsService_deleteSiteCustomDomainSettings" parameters: - name: "site_luid" in: "path" required: true schema: type: "string" description: "The LUID of the Tableau site associated with the custom domain." - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.customdomains.v1.DeleteSiteCustomDomainSettingsResponse+json: schema: $ref: "#/components/schemas/tableau.customdomains.v1.DeleteSiteCustomDomainSettingsResponse" "400": description: "The request was malformed." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "User could not be authenticated. Credentials were missing\ \ or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "An unknown error occured." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "204": description: "Successful." content: application/vnd.tableau.customdomains.v1.DeleteSiteCustomDomainSettingsResponse+json: schema: $ref: "#/components/schemas/tableau.customdomains.v1.DeleteSiteCustomDomainSettingsResponse" "404": description: "The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Tableau service was unavailable. Retry at a later time." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/metrics:batchGet: get: tags: - "Metric Definitions" summary: "Gets a batch of metrics available on a server." description: "Gets batches of metrics available on a server. Only metrics a\ \ user has privileges to view will be visible." operationId: "MetricQueryService_BatchGetMetrics" parameters: - name: "enable_sorting" in: "query" description: "" required: false schema: type: "boolean" description: "" - $ref: "#/components/parameters/tableau.auth.header" - name: "metric_ids" in: "query" description: "" required: false schema: type: "string" description: "" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.BatchGetMetricsResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.BatchGetMetricsResponse" "200": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.BatchGetMetricsResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.BatchGetMetricsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" post: tags: - "Metric Definitions" summary: "Gets a batch of metrics available on a server." description: "Gets batches of metrics available on a server. Only metrics a\ \ user has privileges to view will be visible. This endpoint uses POST as\ \ an alternative to GET, where long lists of URL parameters could be problematic." operationId: "MetricQueryService_BatchGetMetricsByPost" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.metricqueryservice.v1.BatchGetMetricsByPostRequest+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.BatchGetMetricsByPostRequest" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.BatchGetMetricsByPostResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.BatchGetMetricsByPostResponse" "201": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.BatchGetMetricsByPostResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.BatchGetMetricsByPostResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/measurementPeriods: post: tags: - "Metric Insights" summary: "Gets measurement periods for a given definition." description: "Gets measurement periods for a given definition." operationId: "PulseInsightsService_GetMeasurementPeriods" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.pulse.insightsservice.v1.GetMeasurementPeriodsRequest+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GetMeasurementPeriodsRequest" responses: default: description: "Successful." content: application/vnd.tableau.pulse.insightsservice.v1.GetMeasurementPeriodsResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GetMeasurementPeriodsResponse" "201": description: "Successful." content: application/vnd.tableau.pulse.insightsservice.v1.GetMeasurementPeriodsResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GetMeasurementPeriodsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/authn-service/identity-pools/: get: tags: - "IdentityPool" summary: "List Identity Pools" description: "List all identity pools.\n\n > **Version:** Available in API 3.19\ \ (Tableau Server 2023.1) and later. Not available in Tableau Cloud. *[Versioning\ \ Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Can only be called by users with server administrator\ \ permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm)\ \ | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*" operationId: "AuthnService_ListIdentityPools" responses: default: description: "Successful." content: application/vnd.tableau.authn.v1.ListIdentityPoolsResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.ListIdentityPoolsResponse" "200": description: "Successful." content: application/vnd.tableau.authn.v1.ListIdentityPoolsResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.ListIdentityPoolsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" post: tags: - "IdentityPool" summary: "Create Identity Pool" description: "Create an identity pool.\n\n For more information, see [Step 4:\ \ Create an identity pool](https://help.tableau.com/current/server/en-us/identity_pools_manage.htm#step4)\ \ in the Tableau Server Help.\n\n > **Version:** Available in API 3.19 (Tableau\ \ Server 2023.1) and later. Not available in Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Can only be called by users with server administrator\ \ permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm)\ \ | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*" operationId: "AuthnService_RegisterIdentityPool" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.authn.v1.RegisterIdentityPoolRequest+json: schema: $ref: "#/components/schemas/tableau.authn.v1.RegisterIdentityPoolRequest" responses: default: description: "Successful." content: application/vnd.tableau.authn.v1.RegisterIdentityPoolResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.RegisterIdentityPoolResponse" "201": description: "Successful." content: application/vnd.tableau.authn.v1.RegisterIdentityPoolResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.RegisterIdentityPoolResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/user/preferences: get: tags: - "Subscriptions" summary: "Get user preferences" description: "Gets the user's preferences for notifications channels and cadence,\ \ and for grouping and sorting followed metrics in REST responses and UI." operationId: "PulseSubscriptionService_GetUserPreferences" parameters: - name: "user_id" in: "query" description: "" required: false schema: type: "string" description: "" - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.GetUserPreferencesResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.GetUserPreferencesResponse" "200": description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.GetUserPreferencesResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.GetUserPreferencesResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" patch: tags: - "Subscriptions" summary: "Update user preferences" description: "Updates the user's preferences for notifications channels and\ \ cadence, and for grouping and sorting followed metrics in REST responses\ \ and UI." operationId: "PulseSubscriptionService_UpdateUserPreferences" parameters: - name: "user_id" in: "query" description: "" required: false schema: type: "string" description: "" - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.pulse.subscriptionservice.v1.UpdateUserPreferencesRequest+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.UpdateUserPreferencesRequest" responses: default: description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.UpdateUserPreferencesResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.UpdateUserPreferencesResponse" "200": description: "Successful." content: application/vnd.tableau.pulse.subscriptionservice.v1.UpdateUserPreferencesResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.UpdateUserPreferencesResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/customdomains/site/{site_luid}: get: tags: - "CustomDomains" summary: "Get Custom Domain Name" description: "Gets the custom domain for a Tableau site, if one is provisioned.\ \ For more information about how, see [Using Custom Domains](https://help.tableau.com/current/online/en-us/custom_domain.htm).\n\ \n > **Version:** Available in API 3.21 (Tableau Cloud October 2023) and later.\ \ Not available for Tableau Server. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Can be called by any user that is a member of the site\ \ associated with the custom domain. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm)*" operationId: "CustomDomainsService_getSiteCustomDomain" parameters: - name: "site_luid" in: "path" required: true schema: type: "string" description: "The LUID of the Tableau site associated with the custom domain." - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.customdomains.v1.GetSiteCustomDomainResponse+json: schema: $ref: "#/components/schemas/tableau.customdomains.v1.GetSiteCustomDomainResponse" "200": description: "Successful." content: application/vnd.tableau.customdomains.v1.GetSiteCustomDomainResponse+json: schema: $ref: "#/components/schemas/tableau.customdomains.v1.GetSiteCustomDomainResponse" "400": description: "The request was malformed." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "User could not be authenticated. Credentials were missing\ \ or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "An unknown error occured." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Tableau service was unavailable. Retry at a later time." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/eventservice/events: post: tags: - "Event Stream" summary: "Publish a Pulse event." description: "Publish a new event on the Pulse Event Stream." operationId: "EventService_Publish" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.eventservice.v1.PublishRequest+json: schema: $ref: "#/components/schemas/tableau.eventservice.v1.PublishRequest" responses: default: description: "Successful." content: application/vnd.tableau.eventservice.v1.PublishResponse+json: schema: $ref: "#/components/schemas/tableau.eventservice.v1.PublishResponse" "201": description: "Successful." content: application/vnd.tableau.eventservice.v1.PublishResponse+json: schema: $ref: "#/components/schemas/tableau.eventservice.v1.PublishResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/definitions:batchGet: get: tags: - "Metric Definitions" summary: "Gets a batch of definition and metrics available on a server." description: "Gets batches of definitions and metrics available on a server.\ \ Only metrics a user has privileges to view will be visible." operationId: "MetricQueryService_BatchGetDefinitions" parameters: - name: "definition_ids" in: "query" description: "" required: false schema: type: "string" description: "" - name: "view" in: "query" description: "" required: false schema: type: "string" description: "" enum: - "DEFINITION_VIEW_UNSPECIFIED" - "DEFINITION_VIEW_BASIC" - "DEFINITION_VIEW_FULL" - "DEFINITION_VIEW_DEFAULT" - $ref: "#/components/parameters/tableau.auth.header" - name: "number_of_metrics" in: "query" description: "" required: false schema: type: "integer" description: "" format: "int64" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.BatchGetDefinitionsResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.BatchGetDefinitionsResponse" "200": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.BatchGetDefinitionsResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.BatchGetDefinitionsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" post: tags: - "Metric Definitions" summary: "Gets a batch of definition and metrics available on a server." description: "Gets batches of definitions and metrics available on a server.\ \ Only metrics a user has privileges to view will be visible. This endpoint\ \ uses POST as an alternative to GET, where long lists of URL parameters could\ \ be problematic." operationId: "MetricQueryService_BatchGetDefinitionsByPost" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.metricqueryservice.v1.BatchGetDefinitionsByPostRequest+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.BatchGetDefinitionsByPostRequest" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.BatchGetDefinitionsByPostResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.BatchGetDefinitionsByPostResponse" "201": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.BatchGetDefinitionsByPostResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.BatchGetDefinitionsByPostResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/authn-service/identity-pools/{uuid}: get: tags: - "IdentityPool" summary: "Get Identity Pool" description: "Get information about an identity pool.\n\n > **Version:** Available\ \ in API 3.19 (Tableau Server 2023.1) and later. Not available in Tableau\ \ Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Can only be called by users with server administrator\ \ permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm)\ \ | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*" operationId: "AuthnService_FindIdentityPoolByUuid" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "uuid" in: "path" required: true schema: type: "string" description: "Required. Identity pool ID." responses: default: description: "Successful." content: application/vnd.tableau.authn.v1.FindIdentityPoolByUuidResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.FindIdentityPoolByUuidResponse" "200": description: "Successful." content: application/vnd.tableau.authn.v1.FindIdentityPoolByUuidResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.FindIdentityPoolByUuidResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" put: tags: - "IdentityPool" summary: "Update Identity Pool" description: "Update information about an identity pool.\n\n > **Note:** The\ \ request body must specify all the required and desired parameters, not just\ \ the parameters you want to update.\n\n > **Version:** Available in API 3.19\ \ (Tableau Server 2023.1) and later. Not available in Tableau Cloud. *[Versioning\ \ Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Can only be called by users with server administrator\ \ permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm)\ \ | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*" operationId: "AuthnService_UpdateIdentityPool" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "uuid" in: "path" required: true schema: type: "string" description: "Required. Identity pool ID." requestBody: content: application/vnd.tableau.authn.v1.UpdateIdentityPoolRequest+json: schema: $ref: "#/components/schemas/tableau.authn.v1.UpdateIdentityPoolRequest" responses: default: description: "Successful." content: application/vnd.tableau.authn.v1.UpdateIdentityPoolResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.UpdateIdentityPoolResponse" "200": description: "Successful." content: application/vnd.tableau.authn.v1.UpdateIdentityPoolResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.UpdateIdentityPoolResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" delete: tags: - "IdentityPool" summary: "Delete Identity Pool" description: "Delete an identity pool.\n\n **Note:** In Tableau Server, move\ \ users to another identity pool before deleting an identity pool. Users will\ \ no longer be able to sign in to Tableau Server unless they are a member\ \ of an identity pool.\n\n > **Version:** Available in API 3.19 (Tableau Server\ \ 2023.1) and later. Not available in Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Can only be called by users with server administrator\ \ permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm)\ \ | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*" operationId: "AuthnService_DeleteIdentityPool" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "uuid" in: "path" required: true schema: type: "string" description: "Required. Identity pool ID." responses: default: description: "Empty Response Body" /api/-/pulse/definitions/{definition_id}: get: tags: - "Metric Definitions" summary: "Gets a metric definition based on the specified id." description: "Gets a metric definition and potentially metrics based off it\ \ based on the id." operationId: "MetricQueryService_GetDefinition" parameters: - name: "view" in: "query" description: "" required: false schema: type: "string" description: "" enum: - "DEFINITION_VIEW_UNSPECIFIED" - "DEFINITION_VIEW_BASIC" - "DEFINITION_VIEW_FULL" - "DEFINITION_VIEW_DEFAULT" - $ref: "#/components/parameters/tableau.auth.header" - name: "definition_id" in: "path" required: true schema: type: "string" - name: "number_of_metrics" in: "query" description: "" required: false schema: type: "integer" description: "" format: "int64" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.GetDefinitionResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.GetDefinitionResponse" "200": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.GetDefinitionResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.GetDefinitionResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" delete: tags: - "Metric Definitions" summary: "Deletes a metric definition." description: "Deletes a metric definition." operationId: "MetricQueryService_DeleteDefinition" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "definition_id" in: "path" required: true schema: type: "string" responses: default: description: "Empty Response Body" patch: tags: - "Metric Definitions" summary: "Updates a metric definition." description: "Updates a metric definition." operationId: "MetricQueryService_UpdateDefinition" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "definition_id" in: "path" required: true schema: type: "string" requestBody: content: application/vnd.tableau.metricqueryservice.v1.UpdateDefinitionRequest+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.UpdateDefinitionRequest" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.UpdateDefinitionResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.UpdateDefinitionResponse" "200": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.UpdateDefinitionResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.UpdateDefinitionResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/insights/detail: post: tags: - "Metric Insights" summary: "Generates a detail insight bundle." description: "Generates a detail insight bundle." operationId: "PulseInsightsService_GenerateInsightBundleDetail" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleDetailRequest+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleDetailRequest" responses: default: description: "Successful." content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleDetailResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleDetailResponse" "201": description: "Successful." content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleDetailResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleDetailResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/settings/site/extensions/analytics/connections/{connection_luid}: get: tags: - "Settings" summary: "Get analytics extension details" description: "Get the details of a specified analytics extension connection\ \ to an external service. Permissions - This method can only be called by\ \ users with server or site administrator permissions." operationId: "AnalyticsExtensionsService_getAnalyticsExtensionsConnection" parameters: - name: "connection_luid" in: "path" required: true schema: type: "string" - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ConnectionItem+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionItem" "200": description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ConnectionItem+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionItem" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" put: tags: - "Settings" summary: "Update analytics extension connection of site" description: "Updates the details of specified analytics extension connection\ \ for an external service to a site. Permissions - This method can be called\ \ by site and server administrators." operationId: "AnalyticsExtensionsService_updateAnalyticsExtensionsConnection" parameters: - name: "connection_luid" in: "path" required: true schema: type: "string" - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.analyticsextensions.v1.ConnectionItem+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionItem" responses: default: description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ConnectionItem+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionItem" "200": description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ConnectionItem+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionItem" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" delete: tags: - "Settings" summary: "Delete analytics extension connection from site" description: "Deletes a specific analytics extension connection for an external\ \ service from a site. Permissions - This method can be called by site and\ \ server administrators." operationId: "AnalyticsExtensionsService_deleteAnalyticsExtensionsConnection" parameters: - name: "connection_luid" in: "path" required: true schema: type: "string" - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Empty Response Body" /api/-/settings/site/extensions/analytics: get: tags: - "Settings" summary: "Get enabled state of analytics extensions on site" description: "Gets the enabled/disabled state of analytics extensions on a site.\ \ Permissions - This method can be called by site and server administrators." operationId: "AnalyticsExtensionsService_getAnalyticsExtensionsSiteSettings" parameters: - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.SiteSettings+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.SiteSettings" "200": description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.SiteSettings+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.SiteSettings" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" put: tags: - "Settings" summary: "Update enabled state of analytics extensions on site" description: "Enables or disables analytics extensions on a site. Permissions\ \ - This method can be called by site and server administrators." operationId: "AnalyticsExtensionsService_updateAnalyticsExtensionsSiteSettings" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.analyticsextensions.v1.SiteSettings+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.SiteSettings" responses: default: description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.SiteSettings+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.SiteSettings" "200": description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.SiteSettings+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.SiteSettings" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/authn-service/auth-configurations/{id}: put: tags: - "AuthConfigurations" summary: "Update Authentication Configuration" description: "Update an authentication instance.\n\n **Note:** The request body\ \ must specify all the required and desired parameters, not just the parameters\ \ you want to update.\n\n > **Version:** Available in API 3.19 (Tableau Server\ \ 2023.1) and later. Not available in Tableau Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Can only be called by users with server administrator\ \ permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm)\ \ | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*" operationId: "AuthnService_UpdateAuthConfiguration" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "id" in: "path" required: true schema: type: "integer" description: "Required. Authentication instance ID." format: "int32" requestBody: content: application/vnd.tableau.authn.v1.UpdateAuthConfigurationRequest+json: schema: $ref: "#/components/schemas/tableau.authn.v1.UpdateAuthConfigurationRequest" responses: default: description: "Successful." content: application/vnd.tableau.authn.v1.UpdateAuthConfigurationResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.UpdateAuthConfigurationResponse" "200": description: "Successful." content: application/vnd.tableau.authn.v1.UpdateAuthConfigurationResponse+json: schema: $ref: "#/components/schemas/tableau.authn.v1.UpdateAuthConfigurationResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" delete: tags: - "AuthConfigurations" summary: "Delete Authentication Configuration" description: "Delete an authentication instance.\n\n > **Version:** Available\ \ in API 3.19 (Tableau Server 2023.1) and later. Not available in Tableau\ \ Cloud. *[Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)*\n\ \n > **Permissions:** Can only be called by users with server administrator\ \ permissions. *[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)*\n\ \n > **License:** No additional license required.\n\n > **Access Scope:**\ \ Not available.
*Access Scopes Overview: [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm)\ \ | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)*" operationId: "AuthnService_DeleteAuthConfiguration" parameters: - $ref: "#/components/parameters/tableau.auth.header" - name: "id" in: "path" required: true schema: type: "integer" description: "Required. Authentication instance ID." format: "int32" responses: default: description: "Empty Response Body" /api/-/settings/site/extensions/analytics/connections: get: tags: - "Settings" summary: "List analytics extension connections on site" description: "Lists a site's analytics extension connections for external services.\ \ Permissions- This method can be called by site and server administrators." operationId: "AnalyticsExtensionsService_getAnalyticsExtensionsConnections" parameters: - $ref: "#/components/parameters/tableau.auth.header" responses: default: description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ConnectionList+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionList" "200": description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ConnectionList+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionList" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" post: tags: - "Settings" summary: "Add analytics extension connection to site" description: "Adds an analytics extensions connection for an external service\ \ to a site. Permissions - This method can be called by site and server administrators." operationId: "AnalyticsExtensionsService_addAnalyticsExtensionsConnection" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.analyticsextensions.v1.ConnectionItem+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionItem" responses: default: description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ConnectionItem+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionItem" "201": description: "Successful." content: application/vnd.tableau.analyticsextensions.v1.ConnectionItem+json: schema: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionItem" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/definitions: get: tags: - "Metric Definitions" summary: "Lists the definitions available on a server." description: "Lists the definitions and metrics available on a server. Only\ \ definitions a user has privileges to view will be visible." operationId: "MetricQueryService_ListDefinitions" parameters: - name: "enable_sorting" in: "query" description: "" required: false schema: type: "boolean" description: "" - name: "order_by" in: "query" description: "" required: false schema: type: "string" description: "" - name: "view" in: "query" description: "" required: false schema: type: "string" description: "" enum: - "DEFINITION_VIEW_UNSPECIFIED" - "DEFINITION_VIEW_BASIC" - "DEFINITION_VIEW_FULL" - "DEFINITION_VIEW_DEFAULT" - $ref: "#/components/parameters/tableau.auth.header" - name: "page_size" in: "query" description: "Specifies the number of results in a paged response.\n\n\nExample:\n\ \n\n> `GET ...//definitions?pageSize=50`\n\n\nCombining Path Parameters:\n\ \nA page_size expression can be combined with other path parameters using\ \ an ampersand (&) as a separator, and is typically used along with a page\ \ number expression.\n\n\nLearn more about paginating the response." required: false schema: type: "integer" description: "" format: "int32" - name: "exclude_metrics_without_followers" in: "query" description: "" required: false schema: type: "boolean" description: "" - name: "filter" in: "query" description: "" required: false schema: type: "string" description: "" - name: "metric_id" in: "query" description: "" required: false schema: type: "string" description: "" - name: "number_of_metrics" in: "query" description: "" required: false schema: type: "integer" description: "" format: "int64" - name: "page_token" in: "query" description: "Specifies the page of items to be returned from a requested\ \ list. The value of `page_token` for the next page of returns is found\ \ in the `next_page_token` of the current response. If there are no further\ \ items to return, the value of `next_page_token` will be empty.\n\nExample:\n\ \n> `GET ...//definitions?pageToken={next_page_value}`\nCombining Path Parameters:\n\ \nA page_token expression can be combined with other path parameters using\ \ an ampersand (&) as a separator, and is typically used along with a page\ \ number expression.\n\n\nLearn more about paginating the response." required: false schema: type: "string" description: "" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.ListDefinitionsResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.ListDefinitionsResponse" "200": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.ListDefinitionsResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.ListDefinitionsResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" post: tags: - "Metric Definitions" summary: "Creates a metric definition." description: "Creates a metric definition." operationId: "MetricQueryService_CreateDefinition" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.metricqueryservice.v1.CreateDefinitionRequest+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.CreateDefinitionRequest" responses: default: description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.CreateDefinitionResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.CreateDefinitionResponse" "201": description: "Successful." content: application/vnd.tableau.metricqueryservice.v1.CreateDefinitionResponse+json: schema: $ref: "#/components/schemas/tableau.metricqueryservice.v1.CreateDefinitionResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" /api/-/pulse/insights/springboard: post: tags: - "Metric Insights" summary: "Generates a springboard insight bundle." description: "Generates a springboard insight bundle." operationId: "PulseInsightsService_GenerateInsightBundleSpringboard" parameters: - $ref: "#/components/parameters/tableau.auth.header" requestBody: content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleSpringboardRequest+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleSpringboardRequest" responses: default: description: "Successful." content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleSpringboardResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleSpringboardResponse" "201": description: "Successful." content: application/vnd.tableau.pulse.insightsservice.v1.GenerateInsightBundleSpringboardResponse+json: schema: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleSpringboardResponse" "400": description: "Invalid Request. The requested was incorrect." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "401": description: "Unable to authenticate user. Credentials are missing or invalid." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "500": description: "Unknown error. There was an internal server error." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "404": description: "Bad Request. The requested resource could not be found." content: application/json: schema: $ref: "#/components/schemas/tableau.error" "503": description: "Service unavailable." content: application/json: schema: $ref: "#/components/schemas/tableau.error" components: schemas: tableau.error: type: "object" properties: httpErrorCode: type: "string" message: type: "string" tableau.metricqueryservice.types.v1.AbstractQuerySpecification: properties: abstract_query_string: type: "string" tableau.metricqueryservice.v1.BatchGetDefinitionsByPostResponse: properties: definitions: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Definition" errors: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.BatchGetMetricErrors" tableau.analyticsextensions.v1.ServerSettings: properties: enabled: type: "boolean" tableau.nlp.lens.publicrest.v1.FieldDetail: properties: graph_id: type: "string" description: "Required. Field identifier for ask data. In most cases this\ \ is the column name. But for cases where the same column name repeats\ \ in multiple objects, calculated fields, or for hierarchy fields this\ \ is derived from TDS rules. To identify the graph id for a particular\ \ field, you could create a test lens with all fields from the datasource\ \ and invoke GetLens API to get a list of all fields and their field graph\ \ ids." custom_label: type: "string" description: "Optional. Custom Label of the lens field. If not specified,\ \ the field inherits label from the corresponding datasource field. Up\ \ to 50 characters long" custom_description: type: "string" description: "Optional. Custom Description of the lens field. If not specified,\ \ the field inherits description from the corresponding datasource field.\ \ Up to 4000 characters long" field_synonyms: type: "array" items: type: "string" description: "Optional. Synonyms for the field." value_synonyms: type: "array" items: description: "Optional. Value synonyms of the field." $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.ValueSynonym" tableau.analyticsextensions.v1.ConnectionList: properties: connectionList: type: "array" items: description: "List of connections to external services available for analytics\ \ extensions on a site. Multiple connections are available on a site\ \ for all connection types except Einstein_Discovery, where only a single\ \ connection per site is supported." $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionItem" tableau.metricqueryservice.types.v1.MetricGoals: properties: target: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.TargetValueGoal" threshold: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Threshold" tableau.permissionservice.v1.DeleteDefinitionPermissionsRequest: properties: definition_id: type: "string" member_permissions: type: "array" items: $ref: "#/components/schemas/tableau.permissionservice.v1.MemberPermission" tableau.metricqueryservice.types.v1.VizStateSpecification: properties: viz_state_string: type: "string" tableau.authn.v1.ListIdentityStoresResponse: properties: instances: type: "array" items: $ref: "#/components/schemas/tableau.authn.v1.IdentityStoreInstance" tableau.eventservice.types.v1.SerializedEvent: properties: id: type: "string" type: type: "string" user_id: type: "integer" format: "int32" site_id: type: "integer" format: "int32" session_id: type: "string" timestamp: type: "string" details: type: "string" site_luid: type: "string" user_luid: type: "string" tableau.authn.v1.RegisterIdentityPoolResponse: properties: pool: $ref: "#/components/schemas/tableau.authn.v1.IdentityPool" tableau.metricqueryservice.types.v1.Filter: properties: field: type: "string" operator: type: "string" enum: - "OPERATOR_UNSPECIFIED" - "OPERATOR_EQUAL" - "OPERATOR_NOT_EQUAL" values: type: "array" items: type: "string" include_null: type: "boolean" categorical_values: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.CategoricalValue" tableau.authn.v1.UpdateIdentityPoolResponse: properties: pool: $ref: "#/components/schemas/tableau.authn.v1.IdentityPool" tableau.metricqueryservice.v1.BatchGetMetricsByPostResponse: properties: metrics: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Metric" errors: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.BatchGetMetricErrors" tableau.nlp.lens.publicrest.v1.CreateLensRequest: properties: name: type: "string" description: "Required. Name of the lens . Upto 300 characters" datasource_id: type: "string" description: "Required. Luid of the datasource to which the lens is associated\ \ to" project_id: type: "string" description: "Required. Luid of the project in which lens should be created." description: type: "string" description: "Optional. Description of the lens. 4000 characters maximum" is_feedback_enabled: type: "boolean" description: "Required. Indicates if feedback to lens author setting is\ \ enabled." fields: type: "array" items: description: "Optional. Fields of the lens. If not specified, a lens with\ \ all the qualifying fields from the datasource will be created." $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.FieldDetail" tableau.pulse.insightsservice.v1.Insight: properties: type: type: "string" version: type: "integer" format: "int32" content: type: "string" markup: type: "string" viz: {} facts: {} characterization: type: "string" enum: - "CHARACTERIZATION_UNSPECIFIED" - "CHARACTERIZATION_NORMAL" - "CHARACTERIZATION_UNUSUAL" question: type: "string" score: type: "number" id: type: "string" insight_feedback_metadata: $ref: "#/components/schemas/tableau.pulse.insightsservice.types.v1.InsightFeedbackMetadata" table: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.Table" generation_id: type: "string" tableau.pulse.subscriptionservice.types.v1.MetricGroupingPreferences: properties: group_by: type: "string" enum: - "GROUP_BY_UNSPECIFIED" - "GROUP_BY_RECENTLY_FOLLOWED" - "GROUP_BY_DEFINITION_NAME" - "GROUP_BY_DATASOURCE_LABEL" - "GROUP_BY_TIME_RANGE" sort_order: type: "string" enum: - "SORT_ORDER_UNSPECIFIED" - "SORT_ORDER_ASCENDING" - "SORT_ORDER_DESCENDING" tableau.pulse.insightsservice.v1.GetMeasurementPeriodsRequest.MeasurementPeriodsInput: properties: definition: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.DefinitionSpecification" extension_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.ExtensionOptions" tableau.metricqueryservice.types.v1.Definition: properties: metadata: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Metadata" specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.DefinitionSpecification" extension_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.ExtensionOptions" metrics: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Metric" total_metrics: type: "integer" format: "int64" representation_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.RepresentationOptions" insights_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.InsightsOptions" comparisons: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Comparisons" datasource_goals: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.DatasourceGoalSpecification" certification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Certification" tableau.pulse.subscriptionservice.v1.BatchCreateSubscriptionsResponse: properties: subscriptions: type: "array" items: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.Subscription" tableau.pulse.insightsservice.v1.GenerateInsightBundleBreakdownResponse: properties: bundle_response: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleResponse" tableau.usagestats.v1.ContentItemId: properties: luid: type: "string" type: type: "string" description: "The content type of the specified item, for instance: workbook,\ \ flow, and datasource. Note the content type of a member of the `content_items`\ \ array refers to a single instance of a resource." tableau.permissionservice.v1.MemberError: properties: member_id: type: "string" member_entity_type: type: "string" enum: - "MEMBER_ENTITY_TYPE_UNSPECIFIED" - "MEMBER_ENTITY_TYPE_USER" - "MEMBER_ENTITY_TYPE_GROUP" error_id: type: "string" error_message: type: "string" tableau.pulse.subscriptionservice.types.v1.ChannelPreferencesRequest: properties: channel: type: "string" enum: - "DELIVERY_CHANNEL_UNSPECIFIED" - "DELIVERY_CHANNEL_EMAIL" - "DELIVERY_CHANNEL_SLACK" - "DELIVERY_CHANNEL_MOBILE_PUSH" status: type: "string" enum: - "CHANNEL_STATUS_UNSPECIFIED" - "CHANNEL_STATUS_DISABLED" - "CHANNEL_STATUS_ENABLED" tableau.pulse.insightsservice.v1.GetMeasurementPeriodsRequest.MeasurementPeriodsOptions: properties: now: type: "string" time_zone: type: "string" language: type: "string" enum: - "LANGUAGE_UNSPECIFIED" - "LANGUAGE_DE_DE" - "LANGUAGE_EN_US" - "LANGUAGE_EN_GB" - "LANGUAGE_ES_ES" - "LANGUAGE_FR_FR" - "LANGUAGE_FR_CA" - "LANGUAGE_GA_IE" - "LANGUAGE_IT_IT" - "LANGUAGE_JA_JP" - "LANGUAGE_KO_KR" - "LANGUAGE_NL_NL" - "LANGUAGE_PT_BR" - "LANGUAGE_SV_SE" - "LANGUAGE_TH_TH" - "LANGUAGE_ZH_CN" - "LANGUAGE_ZH_TW" locale: type: "string" enum: - "LOCALE_UNSPECIFIED" - "LOCALE_AR_AE" - "LOCALE_AR_BH" - "LOCALE_AR_DZ" - "LOCALE_AR_EG" - "LOCALE_AR_IQ" - "LOCALE_AR_JO" - "LOCALE_AR_KW" - "LOCALE_AR_LB" - "LOCALE_AR_LY" - "LOCALE_AR_MA" - "LOCALE_AR_OM" - "LOCALE_AR_QA" - "LOCALE_AR_SA" - "LOCALE_AR_SD" - "LOCALE_AR_SY" - "LOCALE_AR_TN" - "LOCALE_AR_YE" - "LOCALE_BE_BY" - "LOCALE_BG_BG" - "LOCALE_CA_ES" - "LOCALE_CS_CZ" - "LOCALE_DA_DK" - "LOCALE_DE_AT" - "LOCALE_DE_CH" - "LOCALE_DE_DE" - "LOCALE_DE_LU" - "LOCALE_EL_CY" - "LOCALE_EL_GR" - "LOCALE_EN_AU" - "LOCALE_EN_CA" - "LOCALE_EN_GB" - "LOCALE_EN_IE" - "LOCALE_EN_IN" - "LOCALE_EN_MT" - "LOCALE_EN_NZ" - "LOCALE_EN_PH" - "LOCALE_EN_SG" - "LOCALE_EN_US" - "LOCALE_EN_ZA" - "LOCALE_ES_AR" - "LOCALE_ES_BO" - "LOCALE_ES_CL" - "LOCALE_ES_CO" - "LOCALE_ES_CR" - "LOCALE_ES_DO" - "LOCALE_ES_EC" - "LOCALE_ES_ES" - "LOCALE_ES_GT" - "LOCALE_ES_HN" - "LOCALE_ES_MX" - "LOCALE_ES_NI" - "LOCALE_ES_PA" - "LOCALE_ES_PE" - "LOCALE_ES_PR" - "LOCALE_ES_PY" - "LOCALE_ES_SV" - "LOCALE_ES_US" - "LOCALE_ES_UY" - "LOCALE_ES_VE" - "LOCALE_ET_EE" - "LOCALE_FI_FI" - "LOCALE_FR_BE" - "LOCALE_FR_CA" - "LOCALE_FR_CH" - "LOCALE_FR_FR" - "LOCALE_FR_LU" - "LOCALE_GA_IE" - "LOCALE_HE_IL" - "LOCALE_HI_IN" - "LOCALE_HR_HR" - "LOCALE_HU_HU" - "LOCALE_ID_ID" - "LOCALE_IN_ID" - "LOCALE_IS_IS" - "LOCALE_IT_CH" - "LOCALE_IT_IT" - "LOCALE_IW_IL" - "LOCALE_JA_JP" - "LOCALE_KO_KR" - "LOCALE_LT_LT" - "LOCALE_LV_LV" - "LOCALE_MK_MK" - "LOCALE_MS_MY" - "LOCALE_MT_MT" - "LOCALE_NL_BE" - "LOCALE_NL_NL" - "LOCALE_NB_NO" - "LOCALE_NO_NO" - "LOCALE_PL_PL" - "LOCALE_PT_BR" - "LOCALE_PT_PT" - "LOCALE_RO_RO" - "LOCALE_RU_RU" - "LOCALE_SK_SK" - "LOCALE_SL_SI" - "LOCALE_SQ_AL" - "LOCALE_SR_BA" - "LOCALE_SR_ME" - "LOCALE_SR_RS" - "LOCALE_SV_SE" - "LOCALE_TH_TH" - "LOCALE_TR_TR" - "LOCALE_UK_UA" - "LOCALE_VI_VN" - "LOCALE_ZH_CN" - "LOCALE_ZH_HK" - "LOCALE_ZH_SG" - "LOCALE_ZH_TW" tableau.authn.v1.RegisterIdentityStoreRequest: properties: type: type: "string" description: "Required. Identity store type used to provision users. Use\ \ 0 to configure a new local identity store. **Note:** Configuring a new\ \ identity store of type Active Directory or LDAP is not supported." enum: - "LOCAL" - "ACTIVE_DIRECTORY" - "LDAP" - "SCIM" name: type: "string" description: "Required. Identity store name. Must be unique." display_name: type: "string" description: "Identity store display name." tableau.metricqueryservice.types.v1.CompareConfig: properties: comparison: type: "string" enum: - "TIME_COMPARISON_UNSPECIFIED" - "TIME_COMPARISON_NONE" - "TIME_COMPARISON_PREVIOUS_PERIOD" - "TIME_COMPARISON_YEAR_AGO_PERIOD" - "TIME_COMPARISON_FISCAL_YEAR_AGO_PERIOD" comparison_period_override: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.ComparisonPeriodOverride" tableau.pulse.insightsservice.v1.GetMeasurementPeriodsResponse.MeasurementPeriodResult: properties: info: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GetMeasurementPeriodsResponse.MeasurementPeriodInfo" error: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.Error" measurement_period: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.MeasurementPeriod" tableau.authn.v1.ListAuthConfigurationsResponse: properties: instances: type: "array" items: $ref: "#/components/schemas/tableau.authn.v1.AuthConfiguration" tableau.pulse.subscriptionservice.types.v1.MetricFollowerCount: properties: metric_id: type: "string" follower_count: type: "integer" format: "int32" tableau.pulse.insightsservice.v1.ScoreWeights: properties: impact_score: type: "number" relevance_score: type: "number" certainty_score: type: "number" tableau.usagestats.v1.ErrorInfo: properties: httpErrorCode: type: "integer" description: "The error code for a failure to return statistics for a content\ \ item in the requested batch." format: "int32" message: type: "string" description: "The error message for a failure to return statistics for a\ \ content item in the requested batch." tableau.pulse.subscriptionservice.types.v1.RecommendedMetrics: properties: metrics: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Metric" recommendation_type: type: "string" enum: - "RECOMMENDATION_TYPE_UNSPECIFIED" - "RECOMMENDATION_TYPE_MOST_FOLLOWED" tableau.eventservice.v1.PublishUIEventRequest: properties: action: type: "string" data_source_id: type: "string" metric_id: type: "string" scoped_metric_id: type: "string" feature_flags: type: "string" metric_definition_type: type: "string" enum: - "METRIC_DEFINITION_TYPE_UNSPECIFIED" - "BASIC_DEFINITION" - "ABSTRACT_QUERY_DEFINITION" - "VIZ_STATE_DEFINITION" timestamp: type: "string" browser: type: "string" language: type: "string" locale: type: "string" embedded_api_version: type: "string" tableau_version: type: "string" embedding_web_component: type: "string" tableau.metricqueryservice.types.v1.ValidationError: properties: user_error_code: type: "string" resource_id: type: "string" error_message: type: "string" tableau.authn.v1.RegisterIdentityPoolRequest: properties: name: type: "string" description: "Required. Identity pool name. Must be unique. This name is\ \ visible on the Tableau Server landing page when users sign in." identity_store_instance: type: "integer" description: "Required. ID of the identity store instance to configure with\ \ this identity pool." format: "int32" auth_type_instance: type: "integer" description: "Required. ID of the authentication instance to configure with\ \ this identity pool." format: "int32" is_enabled: type: "boolean" description: "Identity pool is enabled by default." description: type: "string" description: "Identity pool description displayed to users when they sign\ \ in." tableau.pulse.subscriptionservice.types.v1.ChannelPreferences: properties: channel: type: "string" enum: - "DELIVERY_CHANNEL_UNSPECIFIED" - "DELIVERY_CHANNEL_EMAIL" - "DELIVERY_CHANNEL_SLACK" - "DELIVERY_CHANNEL_MOBILE_PUSH" status: type: "string" enum: - "CHANNEL_STATUS_UNSPECIFIED" - "CHANNEL_STATUS_DISABLED" - "CHANNEL_STATUS_ENABLED" availability: type: "string" enum: - "CHANNEL_AVAILABILITY_UNSPECIFIED" - "CHANNEL_AVAILABILITY_AVAILABLE" - "CHANNEL_AVAILABILITY_UNAVAILABLE" tableau.metricqueryservice.v1.CreateTagResponse: properties: tag: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Tag" tableau.metricqueryservice.v1.BatchGetDefinitionsResponse: properties: definitions: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Definition" errors: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.BatchGetMetricErrors" tableau.pulse.subscriptionservice.types.v1.Subscription: properties: id: type: "string" metric_id: type: "string" follower: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.Follower" create_time: type: "string" update_time: type: "string" tableau.metricqueryservice.types.v1.CustomCalendarConfiguration: properties: day_of_year_field: type: "string" month_of_year_field: type: "string" quarter_field: type: "string" week_of_year_field: type: "string" year_field: type: "string" reference_date_field: type: "string" month_name_field: type: "string" tableau.pulse.subscriptionservice.v1.UserPreferencesResponse: properties: cadence: type: "string" enum: - "CADENCE_UNSPECIFIED" - "CADENCE_DAILY" - "CADENCE_WEEKLY" - "CADENCE_MONTHLY" channel_preferences: type: "array" items: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.ChannelPreferences" metric_grouping_preferences: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.MetricGroupingPreferences" user_id: type: "string" tableau.metricqueryservice.v1.BatchGetMetricsResponse: properties: metrics: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Metric" errors: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.BatchGetMetricErrors" tableau.pulse.subscriptionservice.v1.UpdateUserDigestPreferencesResponse: properties: channel_preferences: type: "array" items: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.ChannelPreferences" cadence: type: "string" enum: - "CADENCE_UNSPECIFIED" - "CADENCE_DAILY" - "CADENCE_WEEKLY" - "CADENCE_MONTHLY" tableau.pulse.subscriptionservice.types.v1.Follower: properties: user_id: type: "string" group_id: type: "string" tableau.pulse.insightsservice.v1.GenerateInsightBundleExplorationRequest: properties: bundle_request: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleRequest" tableau.authn.v1.UpdateAuthConfigurationRequest: properties: id: type: "integer" description: "Required. Authentication instance ID." format: "int32" auth_type: type: "string" description: "Required. Authentication type." enum: - "OIDC" iframed_idp_enabled: type: "boolean" description: "Allows the identity provider (IdP) to authenticate inside\ \ of an iFrame. The IdP must disable clickjack protection to allow iFrame\ \ presentation. Default value is 'false'." oidc: $ref: "#/components/schemas/tableau.authn.v1.OidcConfig" tableau.nlp.lens.publicrest.v1.ImportLensRequest: properties: lens: description: "Required. Lens to be imported" $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.Lens" lens_transformations: description: "Optional. While importing a lens, you might want to change\ \ certain properties of the lens to match the new server. This enables\ \ you to import an exported lens as is without having to modify the lens\ \ itself." $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.LensTransformation" tableau.analyticsextensions.v1.ConnectionItem: properties: host: type: "string" description: "Required. The location of an external service (TabPy, Rserve,\ \ Einstein_Discovery, Generic API, or other) that responds to your analytics\ \ extension requests. The case sensitive value must be a URI, IPv4 or\ \ IPv6 address that is a maximum of 255 Unicode characters. Starting in\ \ v2022.1, a host address can include path information (`www.example.com/path`),\ \ where previous versions supported only the root domain name (`www.example.com`). " port: type: "integer" description: "Required. Integer between 1 and 65535." format: "int32" is_auth_enabled: type: "boolean" description: "For Tableau Online: The value is always true. For on premise\ \ Tableau servers: Optional. Set to true if authentication is enabled\ \ on the external service. If true, username and password are required.\ \ Default is false." username: type: "string" description: "For Tableau Online: A username is always required." password: type: "string" description: "For Tableau Online: A password is always required." is_ssl_enabled: type: "boolean" description: "For Tableau Online: The value is always true. For on premise\ \ Tableau servers: Optional. Set true if SSL is enabled on the external\ \ service. If true, the host address must use HTTPS. Default is false." connection_brief: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionBrief" connection_luid: type: "string" tableau.pulse.insightsservice.v1.GenerateInsightBundleDetailRequest: properties: bundle_request: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleRequest" tableau.metricqueryservice.types.v1.ExtensionOptions: properties: allowed_dimensions: type: "array" items: type: "string" allowed_granularities: type: "array" items: type: "string" enum: - "GRANULARITY_UNSPECIFIED" - "GRANULARITY_BY_YEAR" - "GRANULARITY_BY_QUARTER" - "GRANULARITY_BY_MONTH" - "GRANULARITY_BY_WEEK" - "GRANULARITY_BY_DAY" - "GRANULARITY_BY_FISCAL_YEAR" - "GRANULARITY_BY_FISCAL_QUARTER" offset_from_today: type: "integer" format: "int32" custom_calendar: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.CustomCalendarConfiguration" correlation_candidate_definition_ids: type: "array" items: type: "string" use_dynamic_offset: type: "boolean" tableau.authn.v1.UpdateIdentityPoolRequest: properties: uuid: type: "string" description: "Required. Identity pool ID." name: type: "string" description: "Identity pool name. Must be unique. This name is visible on\ \ the Tableau Server landing page when users sign in." is_enabled: type: "boolean" description: "Identity pool is enabled by default." description: type: "string" description: "Identity pool description displayed to users when they sign\ \ in." tableau.metricqueryservice.types.v1.LastXPeriod: properties: period: type: "integer" format: "int32" period_type: type: "string" enum: - "GRANULARITY_UNSPECIFIED" - "GRANULARITY_BY_YEAR" - "GRANULARITY_BY_QUARTER" - "GRANULARITY_BY_MONTH" - "GRANULARITY_BY_WEEK" - "GRANULARITY_BY_DAY" - "GRANULARITY_BY_FISCAL_YEAR" - "GRANULARITY_BY_FISCAL_QUARTER" include_current_period: type: "boolean" tableau.pulse.subscriptionservice.v1.CreateSubscriptionRequest: properties: metric_id: type: "string" follower: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.Follower" tableau.pulse.insightsservice.v1.SummaryResponse: properties: result: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.Summary" error: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.Error" tableau.pulse.subscriptionservice.v1.UpdateUserPreferencesResponse: properties: user_preferences_response: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.UserPreferencesResponse" tableau.pulse.subscriptionservice.v1.UpdateSubscriptionResponse: properties: subscription: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.Subscription" tableau.authn.v1.RegisterAuthConfigurationResponse: properties: auth_configuration: $ref: "#/components/schemas/tableau.authn.v1.AuthConfiguration" tableau.metricqueryservice.types.v1.Metadata: properties: name: type: "string" description: type: "string" id: type: "string" user_link: type: "string" user_link_name: type: "string" schema_version: type: "string" metric_version: type: "integer" format: "int64" definition_version: type: "integer" format: "int64" last_updated_user: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Metadata.User" related_links: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Link" created_at: type: "string" nestedUser: type: "object" $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Metadata.User" tableau.pulse.insightsservice.v1.GenerateInsightBundleDetailResponse: properties: bundle_response: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleResponse" tableau.permissionservice.v1.DeleteDefinitionPermissionsResponse: properties: definition_id: type: "string" member_permissions: type: "array" items: $ref: "#/components/schemas/tableau.permissionservice.v1.MemberPermission" member_errors: type: "array" items: $ref: "#/components/schemas/tableau.permissionservice.v1.MemberError" tableau.pulse.insightsservice.v1.InsightResponse: properties: result: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.Insight" error: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.Error" insight_type: type: "string" tableau.metricqueryservice.v1.BatchGetMetricsByPostRequest: properties: metric_ids: type: "array" items: type: "string" enable_sorting: type: "boolean" tableau.nlp.lens.publicrest.v1.RecommendedVisualizationGroup: properties: name: type: "string" description: "Name of group." description: type: "string" description: "Description of group." recommended_visualizations: type: "array" items: description: "Recommended Visualizations." $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.RecommendedVisualization" tableau.metricqueryservice.types.v1.Comparisons.Comparison: properties: compare_config: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.CompareConfig" index: type: "integer" format: "int64" tableau.pulse.insightsservice.v1.Goals: properties: target: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.TargetValueGoal" datasource_goals: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.DatasourceGoalSpecification" metric_goals: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.MetricGoals" tableau.nlp.lens.publicrest.v1.ListLensesResponse: properties: lenses: type: "array" items: description: "list of lenses" $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.ListLensItem" tableau.pulse.insightsservice.v1.GenerateInsightBundleExplorationResponse: properties: bundle_response: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleResponse" tableau.pulse.subscriptionservice.v1.BatchGetMetricFollowerCountsResponse: properties: follower_counts: type: "array" items: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.MetricFollowerCount" tableau.pulse.insightsservice.v1.InputMetric: properties: definition: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.DefinitionSpecification" metric_specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.MetricSpecification" extension_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.ExtensionOptions" representation_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.RepresentationOptions" insights_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.InsightsOptions" goals: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.Goals" candidates: type: "array" items: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.CorrelationCandidateDefinition" tableau.metricqueryservice.types.v1.TimeDimension: properties: field: type: "string" tableau.metricqueryservice.types.v1.RepresentationOptions.RowLevelNameField: properties: name_col: type: "string" tableau.metricqueryservice.types.v1.ContributorsOptions: properties: limit: type: "integer" format: "int32" tableau.metricqueryservice.types.v1.DatasourceGoalSpecification: properties: basic_specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.BasicSpecification" viz_state_specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.VizStateSpecification" threshold_basic_specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.BasicSpecification" threshold_viz_state_specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.VizStateSpecification" minimum_granularity: type: "string" enum: - "GRANULARITY_UNSPECIFIED" - "GRANULARITY_BY_YEAR" - "GRANULARITY_BY_QUARTER" - "GRANULARITY_BY_MONTH" - "GRANULARITY_BY_WEEK" - "GRANULARITY_BY_DAY" - "GRANULARITY_BY_FISCAL_YEAR" - "GRANULARITY_BY_FISCAL_QUARTER" benchmark_sentiment_type: type: "string" enum: - "BENCHMARK_SENTIMENT_TYPE_UNSPECIFIED" - "BENCHMARK_SENTIMENT_TYPE_NONE" - "BENCHMARK_SENTIMENT_TYPE_ABOVE_THRESHOLD_IS_UNFAVORABLE" - "BENCHMARK_SENTIMENT_TYPE_BELOW_THRESHOLD_IS_UNFAVORABLE" tableau.eventservice.v1.PublishResponse: properties: event: $ref: "#/components/schemas/tableau.eventservice.types.v1.Event" serialized_event: $ref: "#/components/schemas/tableau.eventservice.types.v1.SerializedEvent" tableau.pulse.subscriptionservice.v1.BatchCreateSubscriptionsRequest: properties: metric_id: type: "string" followers: type: "array" items: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.Follower" tableau.metricqueryservice.types.v1.MetricGroup: properties: group_metadata: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.MetricGroup.GroupMetadata" metrics: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Metric" nestedGroupMetadata: type: "object" $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.MetricGroup.GroupMetadata" tableau.pulse.insightsservice.v1.Error: properties: code: type: "string" message: type: "string" tableau.metricqueryservice.types.v1.Entitlement: properties: entitlement_type: type: "string" enum: - "ENTITLEMENT_TYPE_UNSPECIFIED" - "ENTITLEMENT_TYPE_PULSE_PREMIUM_CONSUMPTION" - "ENTITLEMENT_TYPE_PULSE_DIGEST_CONTROL" - "ENTITLEMENT_TYPE_PULSE_PREMIUM_SCALE" - "ENTITLEMENT_TYPE_PULSE_PREMIUM_INSIGHTS" - "ENTITLEMENT_TYPE_PULSE_PREMIUM_GAI" enabled: type: "boolean" tableau.authn.v1.UUID: properties: value: type: "string" description: "Identity pool ID." tableau.pulse.insightsservice.v1.GetMeasurementPeriodsRequest: properties: input: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GetMeasurementPeriodsRequest.MeasurementPeriodsInput" options: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GetMeasurementPeriodsRequest.MeasurementPeriodsOptions" nestedMeasurementPeriodsInput: type: "object" $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GetMeasurementPeriodsRequest.MeasurementPeriodsInput" nestedMeasurementPeriodsOptions: type: "object" $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GetMeasurementPeriodsRequest.MeasurementPeriodsOptions" tableau.permissionservice.v1.PermissionState: properties: permission: type: "string" enum: - "PERMISSION_UNSPECIFIED" - "PERMISSION_EDIT_DEFINITION" - "PERMISSION_GOAL" has_permission: type: "boolean" tableau.usagestats.v1.UsageStats: properties: hitsTotal: type: "integer" description: "The number of times the content item has been marked as used." format: "int64" hitsLastTwoWeeksTotal: type: "integer" description: "The number of times the content item has been marked as used\ \ in the last two weeks." format: "int64" hitsLastOneMonthTotal: type: "integer" description: "The number of times the content item has been marked as used\ \ in the last month." format: "int64" hitsLastThreeMonthsTotal: type: "integer" description: "The number of times the content item has been marked as used\ \ in the last three months." format: "int64" hitsLastTwelveMonthsTotal: type: "integer" description: "The number of times the content item has been marked as used\ \ in the last tweleve months." format: "int64" tableau.alertservice.v1.AlertInfo: properties: metric_name: type: "string" alert_type: type: "string" enum: - "ALERT_TYPE_UNSPECIFIED" - "ALERT_TYPE_NEW_UNFAVORABLE_TREND" - "ALERT_TYPE_THRESHOLD" tableau.pulse.insightsservice.v1.GenerateInsightBundleBreakdownRequest: properties: bundle_request: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleRequest" tableau.pulse.insightsservice.v1.InsightBundleInput: properties: metadata: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.MetricMetadata" metric: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.InputMetric" tableau.metricqueryservice.types.v1.InsightsOptions: properties: show_insights: type: "boolean" settings: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.InsightsOptions.InsightSetting" nestedInsightSetting: type: "object" $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.InsightsOptions.InsightSetting" tableau.nlp.lens.publicrest.v1.ListLensItem: properties: id: type: "string" description: "Luid of the lens" name: type: "string" description: "Name of the lens" site_id: type: "string" description: "Luid of the site to which the lens belong to." datasource_id: type: "string" description: "Luid of the datasource to which the lens is associated to." project_id: type: "string" description: "Luid of the project." owner_id: type: "string" description: "Luid of the owner of the lens." description: type: "string" description: "Description of the lens." repository_url: type: "string" description: "Internal URL to access the lens." tableau.metricqueryservice.types.v1.RepresentationOptions: properties: type: type: "string" enum: - "NUMBER_FORMAT_TYPE_UNSPECIFIED" - "NUMBER_FORMAT_TYPE_NUMBER" - "NUMBER_FORMAT_TYPE_PERCENT" - "NUMBER_FORMAT_TYPE_CURRENCY" number_units: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.RepresentationOptions.NumberUnits" sentiment_type: type: "string" enum: - "SENTIMENT_TYPE_UNSPECIFIED" - "SENTIMENT_TYPE_NONE" - "SENTIMENT_TYPE_UP_IS_GOOD" - "SENTIMENT_TYPE_DOWN_IS_GOOD" row_level_id_field: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.RepresentationOptions.RowLevelIDField" row_level_entity_names: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.RepresentationOptions.RowLevelEntityNames" row_level_name_field: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.RepresentationOptions.RowLevelNameField" currency_code: type: "string" enum: - "CURRENCY_CODE_UNSPECIFIED" - "CURRENCY_CODE_AED" - "CURRENCY_CODE_AFN" - "CURRENCY_CODE_ALL" - "CURRENCY_CODE_AMD" - "CURRENCY_CODE_ARS" - "CURRENCY_CODE_AUD" - "CURRENCY_CODE_AZN" - "CURRENCY_CODE_BAM" - "CURRENCY_CODE_BDT" - "CURRENCY_CODE_BGN" - "CURRENCY_CODE_BHD" - "CURRENCY_CODE_BND" - "CURRENCY_CODE_BOB" - "CURRENCY_CODE_BRL" - "CURRENCY_CODE_BTN" - "CURRENCY_CODE_BWP" - "CURRENCY_CODE_BYN" - "CURRENCY_CODE_BZD" - "CURRENCY_CODE_CAD" - "CURRENCY_CODE_CDF" - "CURRENCY_CODE_CHF" - "CURRENCY_CODE_CLP" - "CURRENCY_CODE_CNY" - "CURRENCY_CODE_COP" - "CURRENCY_CODE_CRC" - "CURRENCY_CODE_CUP" - "CURRENCY_CODE_CZK" - "CURRENCY_CODE_DKK" - "CURRENCY_CODE_DOP" - "CURRENCY_CODE_DZD" - "CURRENCY_CODE_EGP" - "CURRENCY_CODE_ERN" - "CURRENCY_CODE_ETB" - "CURRENCY_CODE_EUR" - "CURRENCY_CODE_GBP" - "CURRENCY_CODE_GEL" - "CURRENCY_CODE_GTQ" - "CURRENCY_CODE_HKD" - "CURRENCY_CODE_HNL" - "CURRENCY_CODE_HTG" - "CURRENCY_CODE_HUF" - "CURRENCY_CODE_IDR" - "CURRENCY_CODE_ILS" - "CURRENCY_CODE_INR" - "CURRENCY_CODE_IQD" - "CURRENCY_CODE_IRR" - "CURRENCY_CODE_ISK" - "CURRENCY_CODE_JMD" - "CURRENCY_CODE_JOD" - "CURRENCY_CODE_JPY" - "CURRENCY_CODE_KES" - "CURRENCY_CODE_KGS" - "CURRENCY_CODE_KHR" - "CURRENCY_CODE_KRW" - "CURRENCY_CODE_KWD" - "CURRENCY_CODE_KZT" - "CURRENCY_CODE_LAK" - "CURRENCY_CODE_LBP" - "CURRENCY_CODE_LKR" - "CURRENCY_CODE_LYD" - "CURRENCY_CODE_MAD" - "CURRENCY_CODE_MDL" - "CURRENCY_CODE_MKD" - "CURRENCY_CODE_MMK" - "CURRENCY_CODE_MNT" - "CURRENCY_CODE_MVR" - "CURRENCY_CODE_MXN" - "CURRENCY_CODE_MYR" - "CURRENCY_CODE_NAD" - "CURRENCY_CODE_NGN" - "CURRENCY_CODE_NIO" - "CURRENCY_CODE_NOK" - "CURRENCY_CODE_NPR" - "CURRENCY_CODE_NZD" - "CURRENCY_CODE_OMR" - "CURRENCY_CODE_PAB" - "CURRENCY_CODE_PEN" - "CURRENCY_CODE_PHP" - "CURRENCY_CODE_PKR" - "CURRENCY_CODE_PLN" - "CURRENCY_CODE_PYG" - "CURRENCY_CODE_QAR" - "CURRENCY_CODE_RON" - "CURRENCY_CODE_RSD" - "CURRENCY_CODE_RUB" - "CURRENCY_CODE_RWF" - "CURRENCY_CODE_SAR" - "CURRENCY_CODE_SEK" - "CURRENCY_CODE_SGD" - "CURRENCY_CODE_SOS" - "CURRENCY_CODE_SYP" - "CURRENCY_CODE_THB" - "CURRENCY_CODE_TMT" - "CURRENCY_CODE_TND" - "CURRENCY_CODE_TRY" - "CURRENCY_CODE_TTD" - "CURRENCY_CODE_UAH" - "CURRENCY_CODE_USD" - "CURRENCY_CODE_UYU" - "CURRENCY_CODE_UZS" - "CURRENCY_CODE_VED" - "CURRENCY_CODE_VND" - "CURRENCY_CODE_XAF" - "CURRENCY_CODE_XOF" - "CURRENCY_CODE_YER" - "CURRENCY_CODE_ZAR" - "CURRENCY_CODE_ANG" - "CURRENCY_CODE_AOA" - "CURRENCY_CODE_AWG" - "CURRENCY_CODE_BBD" - "CURRENCY_CODE_BIF" - "CURRENCY_CODE_BMD" - "CURRENCY_CODE_BOV" - "CURRENCY_CODE_BSD" - "CURRENCY_CODE_CHE" - "CURRENCY_CODE_CHW" - "CURRENCY_CODE_CLF" - "CURRENCY_CODE_COU" - "CURRENCY_CODE_CUC" - "CURRENCY_CODE_CVE" - "CURRENCY_CODE_DJF" - "CURRENCY_CODE_FJD" - "CURRENCY_CODE_FKP" - "CURRENCY_CODE_GHS" - "CURRENCY_CODE_GIP" - "CURRENCY_CODE_GMD" - "CURRENCY_CODE_GNF" - "CURRENCY_CODE_GYD" - "CURRENCY_CODE_KMF" - "CURRENCY_CODE_KPW" - "CURRENCY_CODE_KYD" - "CURRENCY_CODE_LRD" - "CURRENCY_CODE_LSL" - "CURRENCY_CODE_MGA" - "CURRENCY_CODE_MOP" - "CURRENCY_CODE_MRU" - "CURRENCY_CODE_MUR" - "CURRENCY_CODE_MWK" - "CURRENCY_CODE_MXV" - "CURRENCY_CODE_MZN" - "CURRENCY_CODE_PGK" - "CURRENCY_CODE_SBD" - "CURRENCY_CODE_SCR" - "CURRENCY_CODE_SDG" - "CURRENCY_CODE_SHP" - "CURRENCY_CODE_SLE" - "CURRENCY_CODE_SRD" - "CURRENCY_CODE_SSP" - "CURRENCY_CODE_STN" - "CURRENCY_CODE_SVC" - "CURRENCY_CODE_SZL" - "CURRENCY_CODE_TJS" - "CURRENCY_CODE_TOP" - "CURRENCY_CODE_TWD" - "CURRENCY_CODE_TZS" - "CURRENCY_CODE_UGX" - "CURRENCY_CODE_USN" - "CURRENCY_CODE_UYI" - "CURRENCY_CODE_UYW" - "CURRENCY_CODE_VES" - "CURRENCY_CODE_VUV" - "CURRENCY_CODE_WST" - "CURRENCY_CODE_XCD" - "CURRENCY_CODE_XPF" - "CURRENCY_CODE_ZMW" - "CURRENCY_CODE_ZWL" decimal_places: type: "integer" description: "The number of decimal places to use for values of the metric." nestedNumberUnits: type: "object" $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.RepresentationOptions.NumberUnits" nestedRowLevelIDField: type: "object" $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.RepresentationOptions.RowLevelIDField" nestedRowLevelNameField: type: "object" $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.RepresentationOptions.RowLevelNameField" nestedRowLevelEntityNames: type: "object" $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.RepresentationOptions.RowLevelEntityNames" tableau.pulse.insightsservice.v1.MetricMetadata: properties: name: type: "string" metric_id: type: "string" definition_id: type: "string" tags: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Tag" tableau.pulse.subscriptionservice.v1.UpdateSubscriptionRequest: properties: id: type: "string" metric_id: type: "string" follower: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.Follower" tableau.pulse.insightsservice.v1.GenerateInsightBundleBasicRequest: properties: bundle_request: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleRequest" tableau.metricqueryservice.types.v1.Metadata.User: properties: id: type: "string" tableau.metricqueryservice.types.v1.MeasurementPeriod: properties: granularity: type: "string" enum: - "GRANULARITY_UNSPECIFIED" - "GRANULARITY_BY_YEAR" - "GRANULARITY_BY_QUARTER" - "GRANULARITY_BY_MONTH" - "GRANULARITY_BY_WEEK" - "GRANULARITY_BY_DAY" - "GRANULARITY_BY_FISCAL_YEAR" - "GRANULARITY_BY_FISCAL_QUARTER" range: type: "string" enum: - "RANGE_UNSPECIFIED" - "RANGE_CURRENT_PARTIAL" - "RANGE_LAST_COMPLETE" - "RANGE_BY_CONFIG" last_x_period: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.LastXPeriod" tableau.pulse.subscriptionservice.v1.ListSubscriptionsResponse: properties: subscriptions: type: "array" items: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.Subscription" next_page_token: type: "string" tableau.metricqueryservice.v1.ListDefinitionsResponse: properties: definitions: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Definition" next_page_token: type: "string" total_available: type: "integer" description: "If available, specifies the total number of items in a requested\ \ list" format: "int32" offset: type: "integer" format: "int32" tableau.metricqueryservice.v1.GetOrCreateMetricRequest: properties: definition_id: type: "string" specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.MetricSpecification" tableau.metricqueryservice.types.v1.RepresentationOptions.NumberUnits: properties: singular_noun: type: "string" plural_noun: type: "string" tableau.pulse.insightsservice.v1.GetMeasurementPeriodsResponse.MeasurementPeriodInfo: properties: range: type: "string" tableau.metricqueryservice.types.v1.Comparisons: properties: comparisons: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Comparisons.Comparison" nestedComparison: type: "object" $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Comparisons.Comparison" tableau.metricqueryservice.v1.CreateDefinitionRequest: properties: name: type: "string" description: type: "string" specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.DefinitionSpecification" extension_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.ExtensionOptions" representation_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.RepresentationOptions" insights_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.InsightsOptions" user_link: type: "string" user_link_name: type: "string" comparisons: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Comparisons" datasource_goals: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.DatasourceGoalSpecification" related_links: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Link" certification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Certification" tableau.pulse.subscriptionservice.v1.CreateSubscriptionResponse: properties: subscription: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.Subscription" tableau.metricqueryservice.types.v1.InsightsOptions.InsightSetting: properties: type: type: "string" enum: - "INSIGHT_TYPE_UNSPECIFIED" - "INSIGHT_TYPE_RISKY_MONOPOLY" - "INSIGHT_TYPE_TOP_DRIVERS" - "INSIGHT_TYPE_RECORD_LEVEL_OUTLIERS" - "INSIGHT_TYPE_CURRENT_TREND" - "INSIGHT_TYPE_NEW_TREND" - "INSIGHT_TYPE_TOP_DIMENSION_MEMBER_MOVERS" - "INSIGHT_TYPE_METRIC_FORECAST" - "INSIGHT_TYPE_BOTTOM_CONTRIBUTORS" - "INSIGHT_TYPE_TOP_DETRACTORS" - "INSIGHT_TYPE_UNUSUAL_CHANGE" - "INSIGHT_TYPE_GOAL_BREAKDOWN" - "INSIGHT_TYPE_BENCHMARK_BREAKDOWN" - "INSIGHT_TYPE_CORRELATED_METRIC" - "INSIGHT_TYPE_TOP_CONTRIBUTORS" disabled: type: "boolean" contributors_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.ContributorsOptions" benchmark_breakdown_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.BenchmarkBreakdownOptions" tableau.pulse.insightsservice.v1.GenerateInsightBundleBasicResponse: properties: bundle_response: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleResponse" tableau.metricqueryservice.v1.UpdateDefinitionRequest: properties: definition_id: type: "string" name: type: "string" description: type: "string" specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.DefinitionSpecification" extension_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.ExtensionOptions" representation_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.RepresentationOptions" insights_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.InsightsOptions" user_link: type: "string" user_link_name: type: "string" comparisons: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Comparisons" datasource_goals: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.DatasourceGoalSpecification" related_links: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Link" certification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Certification" tableau.metricqueryservice.v1.GetDefinitionResponse: properties: definition: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Definition" candidate_definitions: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Definition" tableau.metricqueryservice.types.v1.DefinitionSpecification: properties: datasource: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Datasource" basic_specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.BasicSpecification" abstract_query_specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.AbstractQuerySpecification" viz_state_specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.VizStateSpecification" is_running_total: type: "boolean" tableau.pulse.insightsservice.types.v1.InsightFeedbackMetadata: properties: type: type: "string" score: type: "number" dimension_hash: type: "string" candidate_definition_id: type: "string" tableau.analyticsextensions.v1.ConnectionBrief: properties: connection_name: type: "string" description: "Required. The title of the connection." connection_type: type: "string" description: "Required. The kind of service responding to analytics extension\ \ requests. The value can be: TABPY, for a [Tableau TabPy](https://github.com/tableau/TabPy)\ \ server; GENERIC_API for your custom service that complies with the [Analytics\ \ Extensions API spec](https://tableau.github.io/analytics-extensions-api/docs/ae_intro.html);\ \ or RSERVE, for an [Rserve](https://www.tableau.com/solutions/r) service;\ \ or EINSTEIN_DISCOVERY for your instance of [Einstein Discovery](https://help.tableau.com/current/server-linux/en-us/config_r_tabpy.htm)." enum: - "UNDEFINED" - "TABPY" - "RSERVE" - "EINSTEIN_DISCOVERY" - "GENERIC_API" tableau.pulse.subscriptionservice.v1.UpdateUserDigestPreferencesRequest: properties: channel_preferences_request: type: "array" items: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.ChannelPreferencesRequest" cadence: type: "string" enum: - "CADENCE_UNSPECIFIED" - "CADENCE_DAILY" - "CADENCE_WEEKLY" - "CADENCE_MONTHLY" tableau.nlp.lens.publicrest.v1.GetLensResponse: properties: lens: description: "Lens details" $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.Lens" tableau.eventservice.v1.EventInput: properties: type: type: "string" details: type: "string" tableau.pulse.subscriptionservice.v1.GetUserDigestPreferencesResponse: properties: cadence: type: "string" enum: - "CADENCE_UNSPECIFIED" - "CADENCE_DAILY" - "CADENCE_WEEKLY" - "CADENCE_MONTHLY" channel_preferences: type: "array" items: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.ChannelPreferences" tableau.metricqueryservice.types.v1.BatchGetMetricErrors: properties: id: type: "string" error: type: "string" tableau.metricqueryservice.types.v1.Threshold: properties: value: type: "number" threshold_sentiment_type: type: "string" enum: - "BENCHMARK_SENTIMENT_TYPE_UNSPECIFIED" - "BENCHMARK_SENTIMENT_TYPE_NONE" - "BENCHMARK_SENTIMENT_TYPE_ABOVE_THRESHOLD_IS_UNFAVORABLE" - "BENCHMARK_SENTIMENT_TYPE_BELOW_THRESHOLD_IS_UNFAVORABLE" tableau.pulse.insightsservice.v1.GenerateInsightBundleRequest: properties: version: type: "integer" format: "int32" options: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.InsightBundleOptions" input: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.InsightBundleInput" tableau.authn.v1.RegisterIdentityStoreResponse: properties: store_instance: $ref: "#/components/schemas/tableau.authn.v1.IdentityStoreInstance" tableau.metricqueryservice.v1.GetEntitlementsResponse: properties: entitlements: type: "array" items: description: "The set of Pulse features that are enabled for a site." $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Entitlement" tableau.metricqueryservice.v1.CreateMetricResponse: properties: metric: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Metric" tableau.metricqueryservice.types.v1.Measure: properties: field: type: "string" aggregation: type: "string" enum: - "AGGREGATION_UNSPECIFIED" - "AGGREGATION_SUM" - "AGGREGATION_AVERAGE" - "AGGREGATION_MEDIAN" - "AGGREGATION_MAX" - "AGGREGATION_MIN" - "AGGREGATION_COUNT" - "AGGREGATION_COUNT_DISTINCT" - "AGGREGATION_USER" google.protobuf.Any: properties: type_url: type: "string" value: type: "string" format: "byte" tableau.metricqueryservice.v1.GetMetricResponse: properties: metric: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Metric" tableau.authn.v1.RegisterAuthConfigurationRequest: properties: auth_type: type: "string" description: "Required. Authentication type." enum: - "OIDC" iframed_idp_enabled: type: "boolean" description: "Allows the identity provider (IdP) to authenticate inside\ \ of an iFrame. The IdP must disable clickjack protection to allow iFrame\ \ presentation. Default value is 'false'." oidc: $ref: "#/components/schemas/tableau.authn.v1.OidcConfig" tableau.metricqueryservice.v1.BatchGetDefinitionsByPostRequest: properties: definition_ids: type: "array" items: type: "string" view: type: "string" enum: - "DEFINITION_VIEW_UNSPECIFIED" - "DEFINITION_VIEW_BASIC" - "DEFINITION_VIEW_FULL" - "DEFINITION_VIEW_DEFAULT" number_of_metrics: type: "integer" format: "int64" tableau.metricqueryservice.types.v1.ComparisonPeriodOverride: properties: reference_time: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.TimeDimension" comparison_time: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.TimeDimension" granularity: type: "string" enum: - "GRANULARITY_UNSPECIFIED" - "GRANULARITY_BY_YEAR" - "GRANULARITY_BY_QUARTER" - "GRANULARITY_BY_MONTH" - "GRANULARITY_BY_WEEK" - "GRANULARITY_BY_DAY" - "GRANULARITY_BY_FISCAL_YEAR" - "GRANULARITY_BY_FISCAL_QUARTER" tableau.pulse.insightsservice.v1.GenerateInsightBundleBANResponse: properties: bundle_response: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleResponse" tableau.eventservice.types.v1.Event: properties: id: type: "string" event_type: type: "string" service: type: "string" user_id: type: "integer" format: "int32" site_id: type: "integer" format: "int32" session_id: type: "string" timestamp: type: "string" event_properties: $ref: "#/components/schemas/google.protobuf.Any" site_luid: type: "string" user_luid: type: "string" tableau.authn.v1.ListIdentityPoolsResponse: properties: pools: type: "array" items: $ref: "#/components/schemas/tableau.authn.v1.IdentityPool" tableau.metricqueryservice.v1.UpdateMetricResponse: properties: metric: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Metric" tableau.nlp.lens.publicrest.v1.LensField: properties: graph_id: type: "string" description: "Ask data generated internal id of the field." custom_label: type: "string" description: "Custom Label of the lens field. If not specified, the field\ \ inherits label from the corresponding datasource field." custom_description: type: "string" description: "Custom Description of the lens field. If not specified, the\ \ field inherits description from the corresponding datasource field." field_synonyms: type: "array" items: type: "string" description: "Synonyms for the field." inherited_field_synonyms: type: "array" items: type: "string" description: "Synonyms for the field inherited from datasource." value_synonyms: type: "array" items: description: "Value synonyms of the field." $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.ValueSynonym" inherited_value_synonyms: type: "array" items: description: "Value synonyms of the field inherited from datasource" $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.ValueSynonym" tableau.authn.v1.UpdateAuthConfigurationResponse: properties: auth_configuration: $ref: "#/components/schemas/tableau.authn.v1.AuthConfiguration" tableau.metricqueryservice.v1.CreateTagRequest: properties: metric_id: type: "string" category: type: "string" enum: - "CATEGORY_UNSPECIFIED" - "CATEGORY_USER_DEFINED" - "CATEGORY_SYSTEM_DEFINED" value: type: "string" referrer: type: "string" description: "" tableau.pulse.insightsservice.v1.InsightBundle: properties: insight_groups: type: "array" items: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.InsightGroup" has_errors: type: "boolean" characterization: type: "string" enum: - "CHARACTERIZATION_UNSPECIFIED" - "CHARACTERIZATION_NORMAL" - "CHARACTERIZATION_UNUSUAL" tableau.nlp.lens.publicrest.v1.LensTransformation: properties: name: type: "string" description: "Optional. If provided, this will be the name of the imported\ \ lens. Upto 300 characters" description: type: "string" description: "Optional. If provided, this will be the description of the\ \ imported lens. 4000 characters maximum" datasource_id: type: "string" description: "Optional. If provided, this will be luid of the datasource\ \ to which the lens is associated to" project_id: type: "string" description: "Optional. If provided, this will be the luid of the project\ \ to which the lens will be imported to." owner_id: type: "string" description: "Optional. If provided, this will be the luid of the owner\ \ of the lens." tableau.pulse.insightsservice.v1.GenerateInsightBundleSpringboardRequest: properties: bundle_request: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleRequest" tableau.nlp.lens.publicrest.v1.RecommendedVisualization: properties: expression: type: "string" description: "LOD expression." interpretation: type: "string" description: "Natural language interpretation." colloquial_alias: type: "string" description: "Alias of the visualization." tableau.pulse.insightsservice.v1.InsightGroup: properties: type: type: "string" insights: type: "array" items: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.InsightResponse" summaries: type: "array" items: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.SummaryResponse" error: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.Error" tableau.metricqueryservice.v1.ListMetricsResponse: properties: metrics: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Metric" next_page_token: type: "string" total_available: type: "integer" description: "If available, specifies the total number of items in a requested\ \ list" format: "int32" offset: type: "integer" format: "int32" tableau.pulse.subscriptionservice.v1.GetUserPreferencesResponse: properties: user_preferences_response: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.v1.UserPreferencesResponse" tableau.nlp.lens.publicrest.v1.Lens: properties: id: type: "string" description: "Luid of the lens" name: type: "string" description: "Name of the lens" site_id: type: "string" description: "Luid of the site to which the lens belong to." datasource_id: type: "string" description: "Luid of the datasource to which the lens is associated to." project_id: type: "string" description: "Luid of the project." owner_id: type: "string" description: "Luid of the owner of the lens." description: type: "string" description: "Description of the lens." repository_url: type: "string" description: "Internal URL to access the lens." is_feedback_enabled: type: "boolean" description: "Indicates if feedback to lens author setting is enabled" fields: type: "array" items: description: "Fields of the lens." $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.LensField" recommended_visualization_groups: type: "array" items: description: "Custom defined recommended visualizations of the lens." $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.RecommendedVisualizationGroup" tableau.permissionservice.v1.AddDefinitionPermissionsRequest: properties: definition_id: type: "string" member_permissions: type: "array" items: $ref: "#/components/schemas/tableau.permissionservice.v1.MemberPermission" tableau.metricqueryservice.types.v1.RepresentationOptions.RowLevelIDField: properties: identifier_col: type: "string" identifier_label: type: "string" tableau.authn.v1.IdentityStoreInstance: properties: id: type: "integer" description: "Identity store ID." format: "int32" type: type: "string" description: "Identity store type used to provision users." enum: - "LOCAL" - "ACTIVE_DIRECTORY" - "LDAP" - "SCIM" name: type: "string" description: "Identity store name. Must be unique." display_name: type: "string" description: "Identity store display name." created_at: type: "string" description: "Date and time stamp of when the identity store instance was\ \ created." updated_at: type: "string" description: "Date and time stamp of when the identity store instance was\ \ updated." tableau.usagestats.v1.ContentItemUsageStatsList: properties: content_items: type: "array" items: description: "The list of usage statistics successfully returned for each\ \ content item in a requested batch." $ref: "#/components/schemas/tableau.usagestats.v1.ContentItemUsageStats" errors: type: "array" items: description: "The list of reasons for failure to return statistics for\ \ content items in a requested batch." $ref: "#/components/schemas/tableau.usagestats.v1.ErrorInfo" tableau.pulse.insightsservice.v1.ColumnInfo: properties: label: type: "string" tableau.pulse.insightsservice.v1.Summary: properties: id: type: "string" markup: type: "string" viz: {} generation_id: type: "string" timestamp: type: "string" last_attempted_timestamp: type: "string" tableau.pulse.insightsservice.v1.Table: properties: columns: type: "array" items: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.ColumnInfo" rows: type: "array" items: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.Row" tableau.alertservice.v1.ListAlertsResponse: properties: alerts: type: "array" items: $ref: "#/components/schemas/tableau.alertservice.v1.Alert" next_page_token: type: "string" total_available: type: "integer" description: "If available, specifies the total number of items in a requested\ \ list" format: "int32" offset: type: "integer" format: "int32" tableau.usagestats.v1.ContentItemUsageStats: properties: content: description: "The LUID of the content item whose usage statistics are being\ \ returned." $ref: "#/components/schemas/tableau.usagestats.v1.ContentItemId" usage: $ref: "#/components/schemas/tableau.usagestats.v1.UsageStats" tableau.authn.v1.AuthConfiguration: properties: id: type: "integer" description: "Authentication instance ID." format: "int32" created_at: type: "string" description: "Date and time stamp of when the authentication instance was\ \ configured." updated_at: type: "string" description: "Date and time stamp of when the authentication instance was\ \ updated." auth_type: type: "string" enum: - "OIDC" iframed_idp_enabled: type: "boolean" description: "Allows the identity provider (IdP) to authenticate inside\ \ of an iFrame. The IdP must disable clickjack protection to allow iFrame\ \ presentation. Default value is 'false'." oidc: $ref: "#/components/schemas/tableau.authn.v1.OidcConfig" tableau.metricqueryservice.v1.GetOrCreateMetricResponse: properties: metric: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Metric" is_metric_created: type: "boolean" tableau.analyticsextensions.v1.ConnectionMetadata: properties: connection_luid: type: "string" connection_brief: $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionBrief" tableau.metricqueryservice.v1.UpdateMetricRequest: properties: metric_id: type: "string" specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.MetricSpecification" goals: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.MetricGoals" tableau.metricqueryservice.types.v1.RepresentationOptions.RowLevelEntityNames: properties: entity_name_singular: type: "string" entity_name_plural: type: "string" tableau.pulse.subscriptionservice.v1.UpdateUserPreferencesRequest: properties: cadence: type: "string" enum: - "CADENCE_UNSPECIFIED" - "CADENCE_DAILY" - "CADENCE_WEEKLY" - "CADENCE_MONTHLY" channel_preferences_request: type: "array" items: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.ChannelPreferencesRequest" metric_grouping_preferences: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.MetricGroupingPreferences" user_id: type: "string" description: "" tableau.permissionservice.v1.AddDefinitionPermissionsResponse: properties: definition_id: type: "string" member_permissions: type: "array" items: $ref: "#/components/schemas/tableau.permissionservice.v1.MemberPermission" member_errors: type: "array" items: $ref: "#/components/schemas/tableau.permissionservice.v1.MemberError" tableau.pulse.insightsservice.v1.CorrelationCandidateDefinition: properties: id: type: "string" name: type: "string" specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.DefinitionSpecification" extension_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.ExtensionOptions" representation_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.RepresentationOptions" tableau.metricqueryservice.types.v1.Link: properties: link_name: type: "string" link_url: type: "string" tableau.metricqueryservice.types.v1.BasicSpecification: properties: measure: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Measure" time_dimension: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.TimeDimension" filters: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Filter" tableau.eventservice.v1.PublishRequest: properties: service: type: "string" event: $ref: "#/components/schemas/tableau.eventservice.v1.EventInput" tableau.pulse.insightsservice.v1.GenerateInsightBundleSpringboardResponse: properties: bundle_response: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleResponse" tableau.pulse.subscriptionservice.v1.GetSubscriptionResponse: properties: subscription: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.Subscription" tableau.pulse.insightsservice.v1.GenerateInsightBundleResponse: properties: result: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.InsightBundle" error: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.Error" tableau.eventservice.v1.PublishUIEventResponse: properties: event: $ref: "#/components/schemas/tableau.eventservice.types.v1.Event" tableau.nlp.lens.publicrest.v1.CreateLensResponse: properties: lens: description: "Details of the created lens" $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.Lens" tableau.metricqueryservice.types.v1.BenchmarkBreakdownOptions: properties: limit: type: "integer" format: "int32" tableau.pulse.insightsservice.v1.InsightBundleOptions: properties: output_format: type: "string" enum: - "OUTPUT_FORMAT_UNSPECIFIED" - "OUTPUT_FORMAT_HTML" - "OUTPUT_FORMAT_TEXT" now: type: "string" time_zone: type: "string" score_weights: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.ScoreWeights" language: type: "string" enum: - "LANGUAGE_UNSPECIFIED" - "LANGUAGE_DE_DE" - "LANGUAGE_EN_US" - "LANGUAGE_EN_GB" - "LANGUAGE_ES_ES" - "LANGUAGE_FR_FR" - "LANGUAGE_FR_CA" - "LANGUAGE_GA_IE" - "LANGUAGE_IT_IT" - "LANGUAGE_JA_JP" - "LANGUAGE_KO_KR" - "LANGUAGE_NL_NL" - "LANGUAGE_PT_BR" - "LANGUAGE_SV_SE" - "LANGUAGE_TH_TH" - "LANGUAGE_ZH_CN" - "LANGUAGE_ZH_TW" locale: type: "string" enum: - "LOCALE_UNSPECIFIED" - "LOCALE_AR_AE" - "LOCALE_AR_BH" - "LOCALE_AR_DZ" - "LOCALE_AR_EG" - "LOCALE_AR_IQ" - "LOCALE_AR_JO" - "LOCALE_AR_KW" - "LOCALE_AR_LB" - "LOCALE_AR_LY" - "LOCALE_AR_MA" - "LOCALE_AR_OM" - "LOCALE_AR_QA" - "LOCALE_AR_SA" - "LOCALE_AR_SD" - "LOCALE_AR_SY" - "LOCALE_AR_TN" - "LOCALE_AR_YE" - "LOCALE_BE_BY" - "LOCALE_BG_BG" - "LOCALE_CA_ES" - "LOCALE_CS_CZ" - "LOCALE_DA_DK" - "LOCALE_DE_AT" - "LOCALE_DE_CH" - "LOCALE_DE_DE" - "LOCALE_DE_LU" - "LOCALE_EL_CY" - "LOCALE_EL_GR" - "LOCALE_EN_AU" - "LOCALE_EN_CA" - "LOCALE_EN_GB" - "LOCALE_EN_IE" - "LOCALE_EN_IN" - "LOCALE_EN_MT" - "LOCALE_EN_NZ" - "LOCALE_EN_PH" - "LOCALE_EN_SG" - "LOCALE_EN_US" - "LOCALE_EN_ZA" - "LOCALE_ES_AR" - "LOCALE_ES_BO" - "LOCALE_ES_CL" - "LOCALE_ES_CO" - "LOCALE_ES_CR" - "LOCALE_ES_DO" - "LOCALE_ES_EC" - "LOCALE_ES_ES" - "LOCALE_ES_GT" - "LOCALE_ES_HN" - "LOCALE_ES_MX" - "LOCALE_ES_NI" - "LOCALE_ES_PA" - "LOCALE_ES_PE" - "LOCALE_ES_PR" - "LOCALE_ES_PY" - "LOCALE_ES_SV" - "LOCALE_ES_US" - "LOCALE_ES_UY" - "LOCALE_ES_VE" - "LOCALE_ET_EE" - "LOCALE_FI_FI" - "LOCALE_FR_BE" - "LOCALE_FR_CA" - "LOCALE_FR_CH" - "LOCALE_FR_FR" - "LOCALE_FR_LU" - "LOCALE_GA_IE" - "LOCALE_HE_IL" - "LOCALE_HI_IN" - "LOCALE_HR_HR" - "LOCALE_HU_HU" - "LOCALE_ID_ID" - "LOCALE_IN_ID" - "LOCALE_IS_IS" - "LOCALE_IT_CH" - "LOCALE_IT_IT" - "LOCALE_IW_IL" - "LOCALE_JA_JP" - "LOCALE_KO_KR" - "LOCALE_LT_LT" - "LOCALE_LV_LV" - "LOCALE_MK_MK" - "LOCALE_MS_MY" - "LOCALE_MT_MT" - "LOCALE_NL_BE" - "LOCALE_NL_NL" - "LOCALE_NB_NO" - "LOCALE_NO_NO" - "LOCALE_PL_PL" - "LOCALE_PT_BR" - "LOCALE_PT_PT" - "LOCALE_RO_RO" - "LOCALE_RU_RU" - "LOCALE_SK_SK" - "LOCALE_SL_SI" - "LOCALE_SQ_AL" - "LOCALE_SR_BA" - "LOCALE_SR_ME" - "LOCALE_SR_RS" - "LOCALE_SV_SE" - "LOCALE_TH_TH" - "LOCALE_TR_TR" - "LOCALE_UK_UA" - "LOCALE_VI_VN" - "LOCALE_ZH_CN" - "LOCALE_ZH_HK" - "LOCALE_ZH_SG" - "LOCALE_ZH_TW" tableau.metricqueryservice.v1.ValidateDefinitionRequest: properties: definition_id: type: "string" name: type: "string" description: type: "string" specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.DefinitionSpecification" extension_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.ExtensionOptions" representation_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.RepresentationOptions" insights_options: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.InsightsOptions" user_link: type: "string" user_link_name: type: "string" comparisons: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Comparisons" datasource_goals: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.DatasourceGoalSpecification" related_links: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Link" tableau.pulse.subscriptionservice.v1.ListFollowedMetricsGroupsResponse: properties: metric_groups: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.MetricGroup" group_by: type: "string" enum: - "GROUP_BY_UNSPECIFIED" - "GROUP_BY_RECENTLY_FOLLOWED" - "GROUP_BY_DEFINITION_NAME" - "GROUP_BY_DATASOURCE_LABEL" - "GROUP_BY_TIME_RANGE" sort_order: type: "string" enum: - "SORT_ORDER_UNSPECIFIED" - "SORT_ORDER_ASCENDING" - "SORT_ORDER_DESCENDING" errors: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.BatchGetMetricErrors" tableau.metricqueryservice.types.v1.Metric: properties: id: type: "string" specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.MetricSpecification" definition_id: type: "string" is_default: type: "boolean" schema_version: type: "string" metric_version: type: "integer" format: "int64" goals: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.MetricGoals" is_followed: type: "boolean" tags: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Tag" datasource_luid: type: "string" tableau.metricqueryservice.types.v1.Certification: properties: is_certified: type: "boolean" modified_by: type: "string" modified_at: type: "string" tableau.pulse.insightsservice.v1.GenerateInsightBundleBANRequest: properties: bundle_request: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GenerateInsightBundleRequest" tableau.customdomains.v1.SiteCustomDomainSettingsResponse: properties: site_luid: type: "string" description: "The LUID of the Tableau site associated with the custom domain." custom_domain: type: "string" description: "The custom domain associated with the Tableau site." intermediate_domain: type: "string" description: "The Tableau intermediate domain associated with the site." status: type: "string" description: "The provisioning status of the custom domain." enum: - "Requested" - "CnameVerificationRequested" - "CnameVerificationInProgress" - "CnameVerificationFailed" - "CnameVerificationSuccess" - "Provisioning" - "Deleting" - "CustomDomainProvisioned" request_initiation_date: type: "string" description: "The timestamp of when the create request was received. The\ \ format is like: 2024-06-05T08:15:09Z." tls_certificate_uploaded_date: type: "string" description: "The timestamp of when the TLS certificate was uploaded. The\ \ format is like: 2024-06-05T08:15:09Z." tls_certificate_expiry_date: type: "string" description: "The TLS certificate expiry date. The format is like: 2024-06-05T08:15:09Z." certificate_update_in_progress: type: "boolean" description: "Indicates whether or not a certificate update is in progress." last_error: type: "string" description: "Latest error which happened during certificate provisioning." tableau.metricqueryservice.types.v1.MetricGroup.GroupMetadata: properties: group_label: type: "string" description: "The name of the metrics group." tableau.metricqueryservice.v1.UpdateDefinitionResponse: properties: definition: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Definition" tableau.customdomains.v1.SiteCustomDomainSettingsRequest: properties: site_luid: type: "string" description: "The LUID of the Tableau site associated with the custom domain." custom_domain: type: "string" description: "The custom domain associated with the Tableau site." status: type: "string" description: "The provisioning status of the custom domain." enum: - "Requested" - "CnameVerificationRequested" - "CnameVerificationInProgress" - "CnameVerificationFailed" - "CnameVerificationSuccess" - "Provisioning" - "Deleting" - "CustomDomainProvisioned" tls_certificate: type: "string" description: "The TLS certificate for the custom domain, including the CA\ \ certs." tls_certificate_private_key: type: "string" description: "The private key corresponding to the TLS certificate." tableau.pulse.insightsservice.v1.Row: properties: entries: type: "array" items: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.RowEntryResult" tableau.analyticsextensions.v1.SiteSettings: properties: enabled: type: "boolean" tableau.pulse.subscriptionservice.v1.GetRecommendedMetricsResponse: properties: recommended_metrics: type: "array" items: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.RecommendedMetrics" tableau.pulse.subscriptionservice.v1.BatchGetSubscriptionsResponse: properties: subscriptions: type: "array" items: $ref: "#/components/schemas/tableau.pulse.subscriptionservice.types.v1.Subscription" tableau.authn.v1.OidcConfig: properties: client_id: type: "string" description: "Required. Provider client ID that the IdP has assigned to\ \ Tableau Server." client_secret: type: "string" description: "Required. Provider client secret. This is a token that is\ \ used by Tableau Server to verify the authenticity of the response from\ \ the IdP. This value should be kept securely." config_url: type: "string" description: "Required. Provider configuration URL. Specifies the location\ \ of the provider configuration discovery document that contains the OpenID\ \ provider metadata." custom_scope: type: "string" description: "Custom scope user-related value to query the IdP." id_claim: type: "string" description: "Required. Claim for retrieving user ID from the OIDC token.\ \ Default value is 'sub'." username_claim: type: "string" description: "Required. Claim for retrieving username from the OIDC token.\ \ Default value is 'email'." client_authentication: type: "string" description: "Required. Token endpoint authentication method. Default value\ \ is 'CLIENT_SECRET_BASIC'." essential_acr_values: type: "string" description: "List of essential Authentication Context Reference Class values\ \ used for authentication." voluntary_acr_values: type: "string" description: "List of voluntary Authentication Context Reference Class values\ \ used for authentication." prompt: type: "string" description: "Prompts the user for re-authentication and consent." connection_timeout: type: "integer" description: "Wait time (in seconds) for connecting to the IdP." format: "int32" read_timeout: type: "integer" description: "Wait time (in seconds) for data from the IdP." format: "int32" ignore_domain: type: "boolean" description: "Set value to 'true' only if the following are true: you are\ \ using email addresses as usernames in Tableau Server, you have provisioned\ \ users in the IdP with multiple domains, and you want to ignore the domain\ \ name portion of the email claim from the IdP. Default value is 'false'." ignore_jwk: type: "boolean" description: "Set value to 'true' if the IdP does not support JWK validation.\ \ Default value is 'false'." tableau.permissionservice.v1.GetDefinitionPermissionsResponse: properties: definition_id: type: "string" member_permissions: type: "array" items: $ref: "#/components/schemas/tableau.permissionservice.v1.MemberPermission" tableau.nlp.lens.publicrest.v1.ImportLensResponse: properties: lens: description: "Details of the imported lens" $ref: "#/components/schemas/tableau.nlp.lens.publicrest.v1.Lens" tableau.authn.v1.FindIdentityPoolByUuidResponse: properties: pool: $ref: "#/components/schemas/tableau.authn.v1.IdentityPool" tableau.metricqueryservice.v1.CreateDefinitionResponse: properties: definition: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Definition" tableau.metricqueryservice.v1.ValidateDefinitionResponse: properties: is_definition_valid: type: "boolean" validation_errors: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.ValidationError" tableau.metricqueryservice.types.v1.MetricSpecification: properties: filters: type: "array" items: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.Filter" measurement_period: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.MeasurementPeriod" comparison: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.CompareConfig" tableau.analyticsextensions.v1.ConnectionMetadataList: properties: connectionMetadataList: type: "array" items: description: "List of basic connection details, including connection type\ \ and name, for each analytics extension connection available on a site." $ref: "#/components/schemas/tableau.analyticsextensions.v1.ConnectionMetadata" tableau.customdomains.v1.DeleteSiteCustomDomainSettingsResponse: properties: site_luid: type: "string" description: "The LUID of the Tableau site associated with the custom domain." tableau.nlp.lens.publicrest.v1.ValueSynonym: properties: value: type: "string" description: "Original value" synonyms: type: "array" items: type: "string" description: "Synonyms for the value" tableau.permissionservice.v1.MemberPermission: properties: member_id: type: "string" member_entity_type: type: "string" enum: - "MEMBER_ENTITY_TYPE_UNSPECIFIED" - "MEMBER_ENTITY_TYPE_USER" - "MEMBER_ENTITY_TYPE_GROUP" permission: type: "string" enum: - "PERMISSION_UNSPECIFIED" - "PERMISSION_EDIT_DEFINITION" - "PERMISSION_GOAL" tableau.alertservice.v1.Alert: properties: id: type: "string" metric_id: type: "string" alert_info: $ref: "#/components/schemas/tableau.alertservice.v1.AlertInfo" create_time: type: "string" delivery_time: type: "string" tableau.authn.v1.IdentityPool: properties: identity_pool_id: description: "Identity pool ID." $ref: "#/components/schemas/tableau.authn.v1.UUID" identity_pool_name: type: "string" description: "Identity pool name. Must be unique. This name is visible on\ \ the Tableau Server landing page when users sign in." identity_store_instance_id: type: "integer" description: "ID of the identity store instance configured with this identity\ \ pool." format: "int32" auth_type_instance_id: type: "integer" description: "ID of the authentication instance configured with this identity\ \ pool." format: "int32" is_enabled: type: "boolean" description: "The identity pool is enabled by default." created_at: type: "string" description: "Date and time stamp of when the identity pool was configured." updated_at: type: "string" description: "Date and time stamp of when the identity pool was updated." description: type: "string" description: "Identity pool description displayed to users when they sign\ \ in." identity_store_type: type: "string" description: "Identity store type used to provision users." enum: - "LOCAL" - "ACTIVE_DIRECTORY" - "LDAP" - "SCIM" auth_type: type: "string" description: "Authentication type configured with this identity pool." enum: - "OIDC" tableau.pulse.insightsservice.v1.RowEntryResult: properties: value: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.RowEntry" error: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.Error" tableau.metricqueryservice.types.v1.TargetValueGoal: properties: value: type: "number" tableau.metricqueryservice.types.v1.Tag: properties: id: type: "string" category: type: "string" enum: - "CATEGORY_UNSPECIFIED" - "CATEGORY_USER_DEFINED" - "CATEGORY_SYSTEM_DEFINED" value: type: "string" created_at: type: "string" created_by: type: "string" tableau.analyticsextensions.v1.ConnectionMapping: properties: workbook_luid: type: "string" connection_luid: type: "string" tableau.permissionservice.v1.HasEffectivePermissionsResponse: properties: definition_id: type: "string" effective_permission_states: type: "array" items: $ref: "#/components/schemas/tableau.permissionservice.v1.PermissionState" tableau.metricqueryservice.types.v1.Datasource: properties: id: type: "string" tableau.pulse.insightsservice.v1.RowEntry: properties: formatted_value: type: "string" tableau.usagestats.v1.BatchGetUsageRequest: properties: content_items: type: "array" items: description: "A list of content items whose usage statistics are being\ \ requested." $ref: "#/components/schemas/tableau.usagestats.v1.ContentItemId" tableau.customdomains.v1.GetSiteCustomDomainResponse: properties: site_luid: type: "string" description: "The LUID of the Tableau site associated with the custom domain." custom_domain: type: "string" description: "The custom domain associated with the Tableau site." tableau.pulse.insightsservice.v1.GetMeasurementPeriodsResponse: properties: measurement_periods: type: "array" items: $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GetMeasurementPeriodsResponse.MeasurementPeriodResult" nestedMeasurementPeriodInfo: type: "object" $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GetMeasurementPeriodsResponse.MeasurementPeriodInfo" nestedMeasurementPeriodResult: type: "object" $ref: "#/components/schemas/tableau.pulse.insightsservice.v1.GetMeasurementPeriodsResponse.MeasurementPeriodResult" tableau.metricqueryservice.types.v1.CategoricalValue: properties: string_value: type: "string" bool_value: type: "boolean" null_value: type: "string" enum: - "NULL_VALUE" tableau.metricqueryservice.v1.CreateMetricRequest: properties: definition_id: type: "string" specification: $ref: "#/components/schemas/tableau.metricqueryservice.types.v1.MetricSpecification" parameters: tableau.auth.header: name: "X-Tableau-Auth" in: "header" required: false schema: type: "string" description: "Tableau Authentication Header"