{ "opencollection": "1.0.0", "info": { "name": "Select Star Metadata bi tables API", "version": "1.0.0" }, "items": [ { "info": { "name": "tables", "type": "folder" }, "items": [ { "info": { "name": "tables_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tables/", "params": [ { "name": "cloud_object_format", "value": "", "type": "query", "description": "Filter to only return the entities with the specific file format for the cloud objects." }, { "name": "collections", "value": "", "type": "query", "description": "A comma separated list of collection guids, for to filter the collection items from" }, { "name": "databases", "value": "", "type": "query", "description": "A comma separated list of database guids to filter for items within those databases." }, { "name": "datasources", "value": "", "type": "query", "description": "A comma separated list of data sources guids to filter for tables." }, { "name": "dbt_projects_names", "value": "", "type": "query", "description": "A comma separated list of dbt project names" }, { "name": "dbt_tags", "value": "", "type": "query", "description": "A comma separated list of tag guids" }, { "name": "dsuser_created_by", "value": "", "type": "query", "description": "A comma separated list of Data Source Users guids to filter for element creator. Allowed Values include DSUser GUIDs + 'known_users' + 'unknown_users'" }, { "name": "filenames", "value": "", "type": "query", "description": "A comma separated list of source file names" }, { "name": "folders", "value": "", "type": "query", "description": "A list of dbt project guids to filter thesetables for. The returned values will be dbt models" }, { "name": "include_counts", "value": "", "type": "query", "description": "Calculate and include total object counts in the response." }, { "name": "is_hidden", "value": "", "type": "query", "description": "A boolean to show hidden objects when true and hide hidden objects when false. Defaults to False." }, { "name": "last_queried_on", "value": "", "type": "query", "description": "Filter objects by last_queried_on. May specify __gt, __gte, __lt or __lte.\n\n API call to: \n\n ENDPOINT/last_queried_on__gt=2021-08-04T15:12:40&last_queried_on__lt=2021-08-23 \n\n will result with objects last_queried_on after August 4th 2021 at 15:12:40, but before August 23rd 2021. \n\n. If you want to include lower or upper bound of the range use __gte or __lte respectively." }, { "name": "new", "value": "", "type": "query", "description": "A boolean which filters for newest tables in the organization." }, { "name": "no_business_owner", "value": "", "type": "query", "description": "A flag that filters out any table that has a business owner." }, { "name": "no_description", "value": "", "type": "query", "description": "A flag that filters out any tables with descriptions" }, { "name": "no_downstream_lineage", "value": "", "type": "query", "description": "A flag that shows only tables with no downstream lineage" }, { "name": "no_popularity", "value": "", "type": "query", "description": "A flag that filters out any table that has a popularity rating." }, { "name": "no_tags", "value": "", "type": "query", "description": "A flag that filters out any tagged tables" }, { "name": "no_technical_owner", "value": "", "type": "query", "description": "A flag that filters out any table that has a technical owner." }, { "name": "no_upstream_lineage", "value": "", "type": "query", "description": "A flag that shows only tables with no upstream lineage" }, { "name": "order", "value": "", "type": "query", "description": "Specify the ordering for the results. \n\n A comma separated list for ordering by multiple fields and a preceding `-` indicates reverse order. \n\nNote: Order is case-sensitive." }, { "name": "owners", "value": "", "type": "query", "description": "A comma separated list of user or team guids to filter for objects within these users as owners (technical or business)." }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "popularity", "value": "", "type": "query", "description": "A comma separated list of popularity ranges (inclusive) can include integers from 1-100 ex) 1-10,90-100 would be the bottom 10 percent and the top 10 percent, respectively. Ranges can overlap." }, { "name": "schemas", "value": "", "type": "query", "description": "A comma separated list of schema guids to filter for tables within those schemas." }, { "name": "search_all", "value": "", "type": "query", "description": "Search a table with multiple types of params in one go" }, { "name": "search_business_owner", "value": "", "type": "query", "description": "Search for an asset using business owner name" }, { "name": "search_collections", "value": "", "type": "query", "description": "Search for an asset using a collection name" }, { "name": "search_description", "value": "", "type": "query", "description": "Search for an asset using its description" }, { "name": "search_location", "value": "", "type": "query", "description": "A search term." }, { "name": "search_name", "value": "", "type": "query", "description": "Search for tables given a table name (upto data source name)" }, { "name": "search_tag_name", "value": "", "type": "query", "description": "Search for an asset using a tag name" }, { "name": "search_technical_owner", "value": "", "type": "query", "description": "Search for an asset using technical owner name" }, { "name": "status_tags", "value": "", "type": "query", "description": "A comma separated list of tag guids" }, { "name": "tables", "value": "", "type": "query", "description": "A list of table guids to filter for" }, { "name": "teams", "value": "", "type": "query", "description": "A comma separated list of team guids to filter for tables owned by users of those teams." }, { "name": "updated_on", "value": "", "type": "query", "description": "Filter objects by updated_on. May specify __gt, __gte, __lt or __lte.\n\n API call to: \n\n ENDPOINT/updated_on__gt=2021-08-04T15:12:40&updated_on__lt=2021-08-23 \n\n will result with objects updated_on after August 4th 2021 at 15:12:40, but before August 23rd 2021. \n\n. If you want to include lower or upper bound of the range use __gte or __lte respectively." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List of the tables available in authenticated user's organization\n\n**Required Role:** Viewer or higher" }, { "info": { "name": "tables_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tables/:guid/", "params": [ { "name": "guid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a single table\n\n**Required Role:** Viewer or higher" }, { "info": { "name": "tables_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/tables/:guid/", "params": [ { "name": "guid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update a single table\n\n**Required Role:** Data Manager or higher" }, { "info": { "name": "tables_frequent_bi_dsusers_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tables/:guid/frequent-bi-dsusers/", "params": [ { "name": "guid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the most frequent BI users that query a table.\n\n**Required Role:** Authenticated User with Active Organization" }, { "info": { "name": "tables_frequent_dsusers_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tables/:guid/frequent-dsusers/", "params": [ { "name": "guid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the most frequent data source users and associated Select Star users (if any) that query specified table\n\n**Required Role:** Authenticated User with Active Organization" }, { "info": { "name": "tables_frequent_teams_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tables/:guid/frequent-teams/", "params": [ { "name": "guid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the teams that most frequently query the specified table.\n\n**Required Role:** Authenticated User with Active Organization" }, { "info": { "name": "tables_frequent_users_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tables/:guid/frequent-users/", "params": [ { "name": "guid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the most frequent users that query specified table\n\n**Required Role:** Authenticated User with Active Organization" }, { "info": { "name": "tables_related_dashboards_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tables/:guid/related-dashboards/", "params": [ { "name": "distance", "value": "", "type": "query", "description": "A search term." }, { "name": "guid", "value": "", "type": "path" }, { "name": "include_hidden", "value": "", "type": "query", "description": "A flag allowing to include hidden dashboards in the response." }, { "name": "order", "value": "", "type": "query", "description": "Specify the ordering for the results. \n\n A comma separated list for ordering by multiple fields and a preceding `-` indicates reverse order. \n\nNote: Order is case-sensitive." }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "relevant_lineage", "value": "", "type": "query", "description": "When `relevant_lineage` is `true`, we only use edges between columns to traverse the graph. Requires relevant lineage to be enabled in the organization; the flag is ignored otherwise." }, { "name": "search_all", "value": "", "type": "query", "description": "A search term." }, { "name": "search_dsuser_created_by", "value": "", "type": "query", "description": "A search term." }, { "name": "search_name", "value": "", "type": "query", "description": "A search term." }, { "name": "updated_on", "value": "", "type": "query", "description": "Filter objects by updated_on. May specify __gt, __gte, __lt or __lte.\n\n API call to: \n\n ENDPOINT/updated_on__gt=2021-08-04T15:12:40&updated_on__lt=2021-08-23 \n\n will result with objects updated_on after August 4th 2021 at 15:12:40, but before August 23rd 2021. \n\n. If you want to include lower or upper bound of the range use __gte or __lte respectively." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Gets a list of related dashboards given a table_guid\n\n**Required Role:** Viewer or higher" }, { "info": { "name": "tables_export_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tables/export/", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a CSV with data to export.\n\n**Required Role:** Viewer or higher" }, { "info": { "name": "tables_frequent_dsusers_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tables/frequent-dsusers/", "params": [ { "name": "datasources", "value": "", "type": "query", "description": "A comma separated list of data source guids to filter for items within those data sources." }, { "name": "only_registered_users", "value": "", "type": "query", "description": "A flag to hide DSUsers with no association with registered application users" }, { "name": "order", "value": "", "type": "query", "description": "Specify the ordering for the results. \n\n A comma separated list for ordering by multiple fields and a preceding `-` indicates reverse order. \n\nNote: Order is case-sensitive." }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "require_email", "value": "", "type": "query", "description": "A flag to hide DSUsers with no associated registered user nor email" }, { "name": "search_name", "value": "", "type": "query", "description": "A search term." }, { "name": "type", "value": "", "type": "query", "description": "A comma separated list of data source types to filter for dsusers within that type" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the most frequent data source users and associated Select Star users (if any) that query a list of tables\n\n**Required Role:** Authenticated User with Active Organization" }, { "info": { "name": "tables_owners_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/tables/owners/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update table owners\n\n**Required Role:** Data Manager or higher" } ] } ], "bundled": true }