Tableau metadata collector
Tableau metadata collector provides read-only access to metadata from a Tableau account.
The Tableau collector harvests metadata from Tableau objects (such as workbooks and dashboards) in the Tableau Online or Tableau Server instances. Use harvested metadata to perform impact analysis and understand how changes to upstream data sources affect Tableau objects.
Tableau version supported
The collector supports Tableau Cloud and Tableau Server. Supports Tableau API versions 3.10 and above on Tableau Server v2022.1.
Authentication supported
The Tableau collector supports the following authentication methods:
Metadata cataloged
The Tableau collector catalogs the following information:
| Object | Information cataloged |
|---|---|
| Databases | Name, Identifier, Description, Database Connection Type |
| Database Schemas | Name, Identifier |
| Database tables | Name, Identifier |
| Database columns | Name, Identifier |
| Tableau Databases | Name, Identifier, Connection Type |
| Tableau Database tables | Name, Identifier, Connection Type |
| Tableau Database columns | Name, Identifier |
| Projects | Name, Description |
| Workbooks | Name, Description, Creator Email, Creator Name, Creator Tableau User, Preview Image, and Workbook URL Note: Unpublished workbooks aren’t cataloged because the Tableau REST APIs don’t return unpublished objects. |
| Dashboards | Name, Creator Email, Creator Name, Creator Tableau User, Preview Image, Dashboard URL, Number of Favorites, and Number of Views Note:
Unpublished dashboards aren’t cataloged because the Tableau REST APIs don’t return
unpublished objects. |
| Views | Name, Creator Email, Creator Name, Creator Tableau User, Number of Views, Number of Favorites, Preview Image, and View URL Note: Unpublished views aren’t cataloged because the Tableau REST APIs don’t return unpublished
objects. |
| Datasource fields | Name, Identifier, Description |
| Calculated fields | Name, Identifier, Description, Calculation Formula, Category, Role, Type |
| Group fields | Name, Identifier, Description, Category, Role, Type |
| Bin fields | Name, Identifier, Description, Category, Role, Type, Bin Size |
| Column fields | Name, Identifier, Description, Category, Role, Type |
| Metrics | Name, Identifier, Description, Creator Email, Creator Name, Creator Tableau User, Metric Url |
| Custom SQL tables | Name, Identifier, Description, SQL Query |
| Embedded data sources | Name, Identifier, Last refresh date |
| Published data sources | Name, Identifier, Description, Last refresh date |
Relationships between objects
Catalog pages show relationships between the following data asset types:| Data asset page | Relationship |
|---|---|
| Databases |
|
| Database Schemas | Tables contained within the schema |
| Database tables |
|
| Database columns |
|
| Tableau Databases | Tableau Tableau Database table contained within the Tableau Database |
| Tableau Database tables | Tableau Column contained within the Tableau Database table |
| Tableau Database columns | Tableau Column Field referencing the Tableau Database Column |
| Projects |
|
| Workbooks |
|
| Dashboards |
|
| Views |
|
| Datasource fields |
|
| Calculated fields |
|
| Group fields | Data sources containing group field |
| Bin fields | Data sources containing group field |
| Column fields |
|
| Custom SQL tables |
|
| Embedded data sources |
|
| Published data sources | Fields contained within the published data source |
Lineage for Tableau
Collected lineage information:| Object | Lineage available |
|---|---|
| Database columns and tables | Fields that use database columns and tables |
| Projects | Databases, Database schemas, Database Tables, Database Columns, Workbooks, Views, Dashboards, custom SQL tables, and Data sources that projects contain |
| Dashboards | Fields and tables that dashboards source their data from |
| Views | Fields and tables that views source their data from |
| Fields | Columns, tables, and other fields that a field uses its data from |
| Tableau Database tables | Tableau Databases containing the Tableau Database table |
| Tableau Database columns | Fields that reference the Tableau Database column, Tableau Database tables containing the Tableau Database column |
| Published data sources | Embedded data sources that were derived from published data source |
| Embedded data sources | Database tables and Database columns that the Embedded data source uses data from. |
| Custom SQL Tables | Database tables and Database columns that the Custom SQL Table uses data from. Note: Lineage isn’t created between Custom SQL Tables and columns or tables that aren’t available in the API. |
Note:
Supported data sources for cross-system
lineage:Cross-system lineage isn’t supported for ODBC connections or when columns or
tables are unavailable in the API.
- Postgresql
- Snowflake
- BigQuery
- Redshift