Coalesce Catalog is a data catalog designed for mass adoption across the whole company.
\nThis Catalog API lets you interact, extend and enhance your data on Catalog.
\nThis documentation will help you get up and running with Catalog's GraphQL API
\nAll GraphQL queries and mutations require a valid Catalog API token
Include your token as an Authorization header on all API queries and mutations
{\"Authorization\": \"Token <API_TOKEN>\"}\n\nPlease contact our support (Slack or catalog-support@coalesce.io) to get your API Token .
We strongly advise you to try the Catalog API Postman collection by selecting the Run in Postman button located at the top right corner of this documentation.
Postman for Web or Postman desktop application.Authorization header (located in the Headers tab).fields of each queryImporting the Catalog API collection into your Postman workspace will create a dedicated collection that won't receive automatic updates. If any changes are made, you'll need to reimport the collection to obtain the latest version.
\nfinance tag to all tables with names containing financegetTables with scope.nameContains = financeattachTags to add the finance tag to tablesCatalog API’s getter endpoint (graphQL queries) are using scopes to narrow down and filter query results.
\nThose scopes are additive, meaning you can combine those and get results matching all scopes conditions altogether.
\n","_postman_id":"db856e3f-93d9-4604-9811-aea65fbaf48f"},{"name":"Sorting","item":[],"id":"e7d5de3d-bbdd-46ae-8b51-4008b7e1da02","description":"Catalog API’s getter endpoints are coming with a sorting system. It is composed of an array of rules to order the set of results you will receive.
\nThose rules are working the same way an SQL ORDER BY would: rules are taken sequentially, the first one will apply and the next one will be used in case of ties.
\nEach rules contains:
\nsortingKey which refers to one fo the resource’s field (id, name, etc) it’s required and specific to each resources. See the endpoints to get the list of sorting keys you can use.direction defining whether you want to order records in ascending (ASC default value) or descending order (DESC)nullsPriority defines where you want results with null values for the sortingKey: either at the end: (LAST default value) or start (FIRST)All dates provided to our queries and mutation Input are expected to follow the ISO 8601 format:
\nyyyy-MM-dd HH:mm:ss (ex: 2023-08-04T16:52:47)yyyy-MM-dd (ex: 2023-08-04)Here are some guidelines to use this documentation.
\n","_postman_id":"e804db1a-b901-4a44-8c54-25635e27e170"},{"name":"Dashboards","item":[{"name":"Get Dashboards","id":"78bfa245-57d6-4663-98b4-3324b5a13154","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenGet all dashboards, with optional scoping, sorting, and pagination.
\nthe scope will help you to filter/narrow down your result
the sorting will help you sort out the result in the order you want
the pagination will help you navigate through the result when there are too many records
scope (optional): scope the dashboard by source, dashboard IDs, folder path or substring of dashboard namesorting (optional): an array of sorting objectspagination (optional)This will allow you to interact with your dashboards in Catalog: Dashboards, Tiles, Viz models
Get all terms, with optional scoping, sorting and pagination
\nthe scope will help you to filter/narrow down your result
the sorting will help you sort out the result in the order you want
the pagination will help you navigate through the result when there are too many records
All tags will be retrieved, including tags on soft deleted and hidden entities. This means tags on:
\nsoft deleted columns, tables, dashboards, terms and any other kind of assets
\nhidden assets: databases, schemas, etc
\nscope (optional): scope the tag by tag IDs or substring of its labelsorting (optional): an array of sorting objectspagination (optional)Create a term either at root level (linkedTagId is null) or as children of a given term
\nname is mandatory
\ndescription is mandatory and should be provided as markdown
\nlinkedTagId will override any linked term on the given tag
\nReturns a Term: use fields described at the top of the section
\n","urlObject":{"protocol":"https","path":["public","graphql"],"host":["api","castordoc","com"],"query":[{"key":"op","value":"createTerm"}],"variable":[]}},"response":[],"_postman_id":"0af3deb7-447e-4bb2-8f2b-eb7873b70dbf"},{"name":"Update Term","id":"19535f02-9ace-4665-9059-c161d64a1115","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenUpdate an existing term, id of a valid term is necessary, all other fields are optional
\nReturns a Term: use fields and relationships specified at the top of this section
\n","urlObject":{"protocol":"https","path":["public","graphql"],"host":["api","castordoc","com"],"query":[{"key":"op","value":"updateTerm"}],"variable":[]}},"response":[],"_postman_id":"19535f02-9ace-4665-9059-c161d64a1115"},{"name":"Delete Term","id":"ae8081de-1d3c-44c1-ac63-eec1fc1031dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenDelete a term, this operation cannot be reversed
\nRequires the id of a valid term
\nboolean: true if deleted, false if not found
\n","urlObject":{"protocol":"https","path":["public","graphql"],"host":["api","castordoc","com"],"query":[{"key":"op","value":"deleteTerm"}],"variable":[]}},"response":[],"_postman_id":"ae8081de-1d3c-44c1-ac63-eec1fc1031dc"}],"id":"556ac497-6bf3-4385-b4b1-483331ca2af0","description":"This will allow you to interact with your Knowledge pages in Catalog
You can get terms, create a term, update a term and delete a term
\nThis will return a Term object with the following fields
\n\n","_postman_id":"556ac497-6bf3-4385-b4b1-483331ca2af0"},{"name":"Tags","item":[{"name":"Get Tags","id":"e3c25ecf-813e-45ee-906e-404e82a45f06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenOnly supported for getMany and update
\n
Get all tags, with optional scoping, sorting and pagination
\nscope will help you to filter/narrow down your resultsorting will help you sort out the result in the order you wantpagination will help you navigate through the result when there are too many recordsAll tags will be retrieved, including tags on soft deleted and hidden entities. This means tags on:
\nscope (optional): scope the tag by tag IDs or substring of its labelsorting (optional): an array of sorting objectspagination (optional)\n\nAttach tags to entities by using their tag labels, and create a new tag if it does not already exist.
\n
With this mutation you can add multiple tags to multiple entities of different types ( Dashboard / Table / Term / Column) as you want
Please check the Introductions section > Attach a tag to your assets (example) to have an example of how to use this mutation
data (required)data is a TagEntityInput array with a maximum of 500 elementsTagEntityInput contains: the tag label, the entityId and entityType\n\nDetach tags to from entities by using their tag labels, and delete the tag if there are no entities attached to it anymore.
\n
With this mutation you can remove multiple tags from multiple entities of different types ( Dashboard / Table / Term) as you want
data (required)data is a TagEntityInput array with a maximum of 500 elementsTagEntityInput contains: the tag label, the entityId and entityTypeThis will allow you to interact with your Tags in Catalog
Get all Quality Checks, with optional scoping, sorting and pagination
\nscope will help you to filter/narrow down your resultpagination will help you navigate through the result when there are too many recordsscope (optional): scope the tag by tag IDs or substring of its labelpagination (optional)With this mutation you can add or update multiple quality checks on a single table.
Quality checks are unique per tableId and externalId combination.
Thus, for a given tableId and externalId pair, we only keep the latest test run.
This means that for the provided checks, if the runAt value is set after the existing one, the new value will replace it. If however one test exists on those keys and has a runAt after the one you’re trying to insert, it will not be added.
data (required) is composed of:
tableId the id of the table to associate the quality tests toqualityChecks an array of quality check inputs containing the following fields:This will allow you to interact with your table’s Quality Tests in Catalog
Get all sources, with optional scoping, sorting and pagination
\nthe scope will help you to filter/narrow down your result
the pagination will help you navigate through the result when there are too many records
scope (optional): scope the sources by origin, technology, type or whether to include sources that have been soft deleted (scopes can be combined and are additives)AMAZON_ATHENA\nANOMALO\nBIGQUERY\nCOALESCE\nCOALESCE_QUALITY\nCOGNOS\nCONFLUENCE\nDATABRICKS\nDBT\nDBT_TEST\nDELTALAKE\nDOMO\nDOMO_DATA\nDREMIO\nDRUID\nDYNAMODB\nEXASOL\nFIREBOLT\nFIVETRAN\nGENERIC_VISUALIZATION\nGENERIC_WAREHOUSE\nGLUE\nGREAT_EXPECTATIONS\nHIVE\nKAFKA\nKEBOOLA\nLOOKER\nLOOKER_STUDIO\nMARIADB\nMETABASE\nMIXPANEL\nMODE\nMONTE_CARLO\nMS_TEAMS\nMYSQL\nNOTION\nORACLE\nPERISCOPE\nPOSTGRES\nPOWERBI\nPRESTODB\nQLIK_SENSE\nREDASH\nREDSHIFT\nS3\nSALESFORCE\nSALESFORCE_REPORTING\nSIGMA\nSIFFLET\nSISENSE\nSLACK\nSNAPLOGIC\nSNOWFLAKE\nSODA\nSQLSERVER\nSSRS\nSTRATEGY\nSUPERSET\nSYNAPSE\nTABLEAU\nTERADATA\nTHOUGHTSPOT\nTRINO\nVERTICA\nZOHO\n\npagination (optional and default to 100 first items)Restricted Access
\nThis endpoint access is restricted. Please reach out to your point of contact at Catalog if you are interested.
This mutation will allow you to create a single custom warehouse source to administrate through this API.
This comes with some restrictions:
\norigin to APItype to WAREHOUSEtechnology to GENERIC_WAREHOUSEdata (required) is composed of:
Restricted Access
\nThis endpoint access is restricted. Please reach out to your point of contact at Catalog if you are interested.
This mutation will allow you to update the API source you created.
Note that in order not to mess with data ingested by Catalog, only the source created from the API will be editable.
\ndata (required) is composed of:
This will allow you to interact with your data and visualization sources
\n","_postman_id":"d2a8551e-5145-4d71-ad96-ca6d7e99fc88"},{"name":"Databases","item":[{"name":"Get Databases","id":"3f77893d-9a34-4a39-bd8a-311ff969e2a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenGet all databases, with optional scoping, sorting and pagination
\nscope will help you to filter/narrow down your resultpagination will help you navigate through the result when there are too many recordsscope (optional): scope the databases by the warehouses they are associated to, their names and whether you want to include soft deleted and hidden records (scopes can be combined and are additives):pagination (optional and default to 100 first items)Restricted Access
\nThis endpoint access is restricted. Please reach out to your point of contact at Catalog if you are interested.
This mutation will allow you to create batches of databases to administrate through this API.
Note that in order not to conflict with Catalog’s extraction system, you will only be able to create databases on warehouses created from this API.
\nYou will also need to craft and provide custom external ids used as technical identifiers.
\ndata (required) is composed of an array of database inputs containing the following fields:
Restricted Access
\nThis endpoint access is restricted. Please reach out to your point of contact at Catalog if you are interested.
This mutation will allow you to batch update the databases you created.
Note that in order not to mess with data ingested by Catalog, only the databases belonging to sources created from the API will be editable.
\ndata (required) is composed of an array of database inputs containing the following fields:
This will allow you to interact with the databases among your warehouses
\n","_postman_id":"fafe5f77-b8ae-4592-8df5-9c9234ec7950"},{"name":"Schemas","item":[{"name":"Get Schemas","id":"bb68135f-cda7-48e4-82ff-e7d5d8ed9023","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenGet all schemas, with optional scoping, sorting and pagination
\nscope will help you to filter/narrow down your resultpagination will help you navigate through the result when there are too many recordsscope (optional): scope the schemas by the warehouses and databases they are associated to, their names and whether you want to include soft deleted and hidden records (scopes can be combined and are additives)pagination (optional and default to 100 first items)This endpoint have restricted access. Please reach out to your point of contact at Catalog if you are interested.
\nThis mutation will allow you to create batches of schemas to administrate through this API.
Note that in order not to conflict with Catalog’s extraction system, you will only be able to create schemas on databases and warehouses created through this API.
\nYou will also need to craft and provide custom external ids used as technical identifiers.
\ndata (required) is composed of an array of schema inputs containing the following fields:
This endpoint have restricted access. Please reach out to your point of contact at Catalog if you are interested.
\nThis mutation will allow you to batch update the schemas you created.
Note that in order not to mess with data ingested by Catalog, only the schemas belonging to sources and databases created from this API will be editable.
\ndata (required) is composed of an array of schema inputs containing the following fields:
This will allow you to interact with the schemas among your databases
\n","_postman_id":"278318ff-1807-4eb1-9fac-edd422f82fdd"},{"name":"Tables","item":[{"name":"Get Tables","id":"88b9b72a-c00c-425b-9f9d-7ed8c43309e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenGet all tables, with optional scoping, sorting and pagination
\nthe scope will help you to filter/narrow down your result
the sorting will help you sort out the result in the order you want
the pagination will help you navigate through the result when there are too many records
scope (optional) can be combined and are additives:sorting (optional): an array of sorting objectspagination (optional)Restricted Access
\nThis endpoint access is restricted. Please reach out to your point of contact at Catalog if you are interested.
This mutation will allow you to create batches of tables to administrate through this API.
Note that in order not to conflict with Catalog’s extraction system, you will only be able to create tables on schemas, databases and warehouses created through this API.
\nYou will also need to craft and provide custom external ids used as technical identifiers.
\ndata (required) is composed of an array of table inputs containing the following fields:
Restricted Access
\nThis endpoint access is restricted. Please reach out to your point of contact at Catalog if you are interested.
This mutation will allow you to batch update the tables you created.
Note that in order not to mess with data ingested by Catalog, only the tables belonging to schemas, databases and sources created from this API will be editable.
\ndata (required) is composed of an array of table inputs containing the following fields:
Restricted Access
\nThis endpoint access is restricted. Please reach out to your point of contact at Catalog if you are interested.
This mutation will allow you to batch update the external descriptions of any table (not only those you created). The external description you push will not interact with the manual description entered in Catalog but might overwrite the external description provided by your source of data (e.g. warehoue or dbt)
data (required) is composed of an array of table inputs containing the following fields:
This will allow you to interact with your Tables in Catalog
Get all columns, with optional scoping, sorting and pagination
\nthe scope will help you to filter/narrow down your result
the sorting will help you sort out the result in the order you want
the pagination will help you navigate through the result when there are too many records
scope (optional): scope the columns by the warehouses and tables they are associated to, their names, descriptions, ids, whether or not the column is a primary key and whether you want to include soft deleted and hidden records (scopes can be combined and are additives)sorting (optional): an array of sorting objectspagination (optional and default to 100 first items)This query returns column objects with the following queryable fields:
Restricted Access
\nThis endpoint access is restricted. Please reach out to your point of contact at Catalog if you are interested.
This mutation will allow you to create batches of columns to administrate through this API.
Note that in order not to conflict with Catalog’s extraction system, you will only be able to create columns on tables (and thus warehouses) created through this API.
\nYou will also need to craft and provide custom external ids used as technical identifiers.
\ndata (required) is composed of an array of column inputs containing the following fields:
Restricted Access
\nThis endpoint access is restricted. Please reach out to your point of contact at Catalog if you are interested.
This mutation will allow you to batch update the columns you created.
Note that in order not to mess with data ingested by Catalog, only the columns belonging to sources and databases created from this API will be editable.
\ndata (required) is composed of an array of column inputs containing the following fields:
Restricted Access
\nThis endpoint access is restricted. Please reach out to your point of contact at Catalog if you are interested.
This mutation will allow you to batch update the external descriptions of any columns (not only those you created). The external description you push will not interact with the manual description entered in Catalog but might overwrite the external description provided by your source of data (e.g. warehouse or dbt)
data (required) is composed of an array of table inputs containing the following fields:
This will allow you to interact with the columns among your tables
\n","_postman_id":"f4c315fa-d870-43e6-a5ed-3e3de6ff2bb9"},{"name":"Column joins","item":[{"name":"Get column joins","id":"7d82689e-981d-446e-9396-0c2502968e9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenGet all column joins, with optional scoping, sorting and pagination
\nthe scope will help you to filter/narrow down your result
the sorting will help you sort out the result in the order you want
the pagination will help you navigate through the result when there are too many records
scope (optional): scope the column joins by the sources, tables and columns they are associated to or their IDs (scopes can be combined and are additives)sorting (optional): an array of sorting objectspagination (optional and default to 100 first items)Column joins feature shows which columns are frequently joined together in SQL queries, using the count attribute. Columns information can be retrieved using the firstColumn and secondColumn relations.
Get all lineages, with optional scoping, sorting and pagination
\nthe scope will help you to filter/narrow down your result
the sorting will help you sort out the result in the order you want
the pagination will help you navigate through the result when there are too many records
scope (optional): scope the assets (column, dashboard field, dashboard) by references or sources they belong to. Also filter on types of link and type of asset. no scope is requiredsorting (optional): an array of sorting objectspagination (optional and default to 100 first items)This collect will allow you to interact with the field lineage links between your assets
\nThere are several links possible and lineage type
\nUnicity lieds upon the 2-uple (link, lineage type)
The following links exist between resources
\nOnly one parent field can be not null on a single row
\nparentColumnId
\nparentDashboardId
\nOnly one children field be not null on a single row
\nchildrenColumnId
\nchildrenDashboardFieldId
\nchildrenDashboardId
\nCatalog supports several lineage types LineageType
Get all lineages, with optional scoping, sorting and pagination
\nscope will help you to filter/narrow down your resultsorting will help you sort out the result in the order you wantpagination will help you navigate through the result when there are too many recordsscope (optional): scope the columns by the warehouses and tables they are associated to, their names, descriptions, ids, whether or not the column is a primary key and whether you want to include soft deleted and hidden records (scopes can be combined and are additives)sorting (optional): an array of sorting objectspagination (optional and default to 100 first items)This mutation will allow you to create or update batches of lineages between your assets.
Note that while all parents/children are marked not required, you will still need to provide valid child/parent couples.
\ndata (required) is composed of an array of lineage inputs containing the following fields:
This mutation will allow you to drop batches of lineages between your assets.
Note that while all parents/children are marked not required, you will still need to provide valid child/parent couples to drop.
\ndata (required) is composed of an array of lineage inputs containing the following fields:
This will allow you to interact with the lineage links between your assets
\n","_postman_id":"850ea7ab-1402-4b0c-87d3-8aacd70409b0"},{"name":"External Links","item":[{"name":"Create External Links","id":"38822456-e8ef-4277-a0b8-4b1c72e42095","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenThis mutation will allow you to create batches of external links to administrate through this API
data (required) is composed of an array of external link inputs containing the following fields:
This mutation will allow you to batch update the external links you created
data (required) is composed of an array of external link inputs containing the following fields:
This mutation will allow you to batch delete the external links you created
data (required) is composed of an array of external link inputs containing the following fields:
This will allow you to interact with the external links among your tables
\nAttach an external link to your table (example)
\nfinancePlease refer this example code
\n","_postman_id":"76e4cb49-28d9-4697-b16f-331d1cfb2823"},{"name":"Teams","item":[{"name":"Get teams","id":"24ad1f18-2224-44e2-b214-d0d1e17bca27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenThis query will allow you to retrieve all teams and their attributes, with the assets they currently own
This mutation will allow you to remove team users from a team.
This mutation will allow you to add team users from a team.
This mutation will allow you to create or update a team.
If the name do not exist, then it will create a new team otherwise it will update the existing team.
\nMutation input
\nThis will allow you to interact with the team ownership
\nRetrieve all teams and their attributes, with the assets they currently own notion
\n","_postman_id":"c0072ef3-8dc0-479c-9651-921786380728"},{"name":"Users","item":[{"name":"Get users","id":"181be559-7a76-43d0-b32e-53e21eb1f524","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenThis query will allow you to retrieve all users and their attributes, with the assets they currently own
This will allow you to interact with the user ownership
\nRetrieve all users and their attributes, with the assets they currently own notion
\n","_postman_id":"0061da1e-1e85-4b5a-9f30-aacdd229dfa5"},{"name":"User Owners","item":[{"name":"Remove User Owners","id":"0df876a0-45ee-4aa4-8183-558304ceedc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"TokenThis query will allow you to remove owner entities for a given user. notionvc: 3fb68f77-7e88-41fb-83bd-be0711240e76
This query will allow you to add owner entities for a given user.
ownerEntity :
This will allow you to interact with user ownership
\nThis query will allow you to remove owner entities for a given team.
This query will allow you to add owner entities for a given team.
ownerEntity :
This will allow you to interact with team ownership
\nRemove team owners
\nUpsert team owners
\nRetrieves top 10 queries that semantically match a given question.
\nYou can filter retrieved queries using the scope argument
The provided question can be translated to English (improve search accuracy)
\ndatascopeThe query return an array of SearchQueryResult (10 max) including:
Create a new AI Assistant job and receive a jobId in response. This jobId will be used later to retrieve the AI Assistant result.
dataThe query return a job Id
\n","urlObject":{"protocol":"https","path":["public","graphql"],"host":["api","castordoc","com"],"query":[{"key":"op","value":"addAiAssistantJob"}],"variable":[]}},"response":[{"id":"82e60c50-33a5-44e4-89f6-886f68b46a76","name":"Add Assistant Job","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"TokenRetrieves the AI Assistant result using the jobId, including a built-in delay to support polling
dataThe query return a Job result
\n","urlObject":{"protocol":"https","path":["public","graphql"],"host":["api","castordoc","com"],"query":[{"key":"op","value":"getAiAssistantJobResult"}],"variable":[]}},"response":[{"id":"46c486e4-3c2c-4d27-9e1d-1c0a4f30e802","name":"Get Assistant Job Result","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"TokenCatalog offers advanced AI capabilities that enable you to create custom AI tools.
\n","_postman_id":"0370b010-71d4-40b1-975b-d7d323316ea2"},{"name":"Data Product","item":[{"name":"Get Data Product","id":"8917c306-c3c8-4169-9a6d-be8ac01f4af3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Token