README.md

Tableau

Overview

Available Operations

• generate_embed_token - Generate JWT token for embedding views
• get_collection_thumbnail - Get collection thumbnail (first view image)
• get_connected_app_status - GetConnectedAppStatus
• get_starred_items - GetStarredTableauItems
• list_tableau_datasources - List Tableau datasources
• list_projects - List Tableau projects
• list_views - List Tableau views
• list_workbooks - List Tableau workbooks
• refresh_collection - RefreshTableauCollection
• reset_connected_app - ResetConnectedApp
• star_item - Star/unstar items
• test_tableau_connection - Test a Tableau connection
• unstar_tableau_item - UnstarTableauItem

generate_embed_token

Generate JWT token for embedding views

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.tableau.generate_embed_token()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
connector_id	Optional[int]	➖	N/A
view_id	Optional[str]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.TableauServiceGenerateEmbedTokenResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

get_collection_thumbnail

Get collection thumbnail (first view image)

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.tableau.get_collection_thumbnail()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
dataset_id	Optional[str]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.TableauServiceGetCollectionThumbnailResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

get_connected_app_status

GetConnectedAppStatus

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.tableau.get_connected_app_status()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
connector_id	Optional[int]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.TableauServiceGetConnectedAppStatusResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

get_starred_items

GetStarredTableauItems

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.tableau.get_starred_items()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
connector_id	Optional[int]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.TableauServiceGetStarredTableauItemsResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

list_tableau_datasources

List Tableau datasources

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.tableau.list_tableau_datasources(body={
        "project_id": "<id>",
    })

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
body	models.TextqlRPCPublicTableauListTableauDatasourcesRequest	✔️	N/A
connect_timeout_ms	Optional[float]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.TableauServiceListTableauDatasourcesResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

list_projects

List Tableau projects

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.tableau.list_projects()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
connector_id	Optional[int]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.TableauServiceListTableauProjectsResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

list_views

List Tableau views

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.tableau.list_views()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
connector_id	Optional[int]	➖	N/A
workbook_id	Optional[str]	➖	N/A
workbook_name	Optional[str]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.TableauServiceListTableauViewsResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

list_workbooks

List Tableau workbooks

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.tableau.list_workbooks()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
connector_id	Optional[int]	➖	N/A
project_id	Optional[str]	➖	N/A
project_name	Optional[str]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.TableauServiceListTableauWorkbooksResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

refresh_collection

RefreshTableauCollection

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.tableau.refresh_collection()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
dataset_id	Optional[str]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.TableauServiceRefreshTableauCollectionResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

reset_connected_app

ResetConnectedApp

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.tableau.reset_connected_app()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
connector_id	Optional[int]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.TableauServiceResetConnectedAppResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

star_item

Star/unstar items

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.tableau.star_item()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
connector_id	Optional[int]	➖	N/A
item_type	Optional[models.TextqlRPCPublicTableauTableauItemType]	➖	Starred items
item_id	Optional[str]	➖	N/A
item_name	Optional[str]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.TableauServiceStarTableauItemResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

test_tableau_connection

Test a Tableau connection

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.tableau.test_tableau_connection()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
connector_id	OptionalNullable[int]	➖	N/A
server_url	OptionalNullable[str]	➖	N/A
site_name	OptionalNullable[str]	➖	N/A
pat_name	OptionalNullable[str]	➖	N/A
pat_secret	OptionalNullable[str]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.TableauServiceTestTableauConnectionResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*

unstar_tableau_item

UnstarTableauItem

Example Usage

import os
from textql_sdk import Textql


with Textql(
    api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:

    res = textql.tableau.unstar_tableau_item()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
connect_timeout_ms	Optional[float]	➖	N/A
connector_id	Optional[int]	➖	N/A
item_type	Optional[models.TextqlRPCPublicTableauTableauItemType]	➖	Starred items
item_id	Optional[str]	➖	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.TableauServiceUnstarTableauItemResponse

Errors

Error Type	Status Code	Content Type
errors.TextqlDefaultError	4XX, 5XX	*/*