GET
/
api
/
entities
/
v1
BatchGetEntities
curl --request GET \
  --url https://developer.synq.io/api/entities/v1 \
  --header 'Authorization: Bearer <token>'
{
  "entities": [
    {
      "workspace": "<string>",
      "id": {
        "airflowDag": {
          "integrationId": "<string>",
          "dagId": "<string>"
        }
      },
      "ids": [
        {
          "airflowDag": {
            "integrationId": "<string>",
            "dagId": "<string>"
          }
        }
      ],
      "synqPaths": [
        "<string>"
      ],
      "typeId": 123,
      "name": "<string>",
      "description": "<string>",
      "createdAt": "1s",
      "updatedAt": "1s",
      "deletedAt": "1s",
      "synqPath": "<string>",
      "synqCatalogUrl": "<string>",
      "annotations": [
        {
          "name": "<string>",
          "values": [
            "<string>"
          ]
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
ids.dbtCoreNode.integrationId
string<uuid>
required

SYNQ integration_id that identifies the dbt Core project

​
ids.dbtCoreNode.nodeId
string
required

Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

​
ids.dbtCloudNode.projectId
string
required

Your dbt Cloud project id

​
ids.dbtCloudNode.accountId
string

Your dbt Cloud account id

​
ids.dbtCloudNode.nodeId
string
required

Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

​
ids.bigqueryTable.project
string
required

BigQuery project

​
ids.bigqueryTable.dataset
string
required

BigQuery dataset id

​
ids.bigqueryTable.table
string
required

BigQuery table name

​
ids.snowflakeTable.account
string
required

Snowflake account

​
ids.snowflakeTable.database
string
required

Snowflake database

​
ids.snowflakeTable.schema
string
required

Snowflake schema

​
ids.snowflakeTable.table
string
required

Snowflake table

​
ids.redshiftTable.cluster
string

Redshift cluster

​
ids.redshiftTable.database
string
required

Redshift database

​
ids.redshiftTable.schema
string
required

Redshift schema

​
ids.redshiftTable.table
string
required

Redshift table

​
ids.postgresTable.host
string
required

Postgres hostname without port

​
ids.postgresTable.database
string
required

Postgres database

​
ids.postgresTable.schema
string
required

Postgres schema

​
ids.postgresTable.table
string
required

Postgres table

​
ids.mysqlTable.host
string
required

Mysql hostname without port

​
ids.mysqlTable.schema
string
required

Mysql database

​
ids.mysqlTable.table
string
required

Mysql table

​
ids.clickhouseTable.host
string
required

Clickhouse hostname without port

​
ids.clickhouseTable.schema
string
required

Clickhouse database

​
ids.clickhouseTable.table
string
required

Clickhouse table

​
ids.airflowDag.integrationId
string
required

SYNQ integration_id that identifies the Airflow instance

​
ids.airflowDag.dagId
string
required

Airflow dag_id that identifies the DAG

​
ids.airflowTask.integrationId
string
required

SYNQ integration_id that identifies the Airflow instance

​
ids.airflowTask.dagId
string
required

Airflow dag_id that identifies the DAG

​
ids.airflowTask.taskId
string
required

Airflow task_id that identifies the task within the DAG

​
ids.custom.id
string
required

Id that identifies the custom entity The Id should be unique within the custom entity Identifier.

​
ids.dataproduct.id
string<uuid>
required

Dataproduct id that identifies the Dataproduct

​
ids.synqPath.path
string
required

SYNQ path that identifies the SYNQ entity, needs to be one of supported paths

​
ids.databricksTable.workspace
string
required

URL of Databricks workspace

​
ids.databricksTable.catalog
string
required

Databricks catalog

​
ids.databricksTable.schema
string
required

Databricks schema

​
ids.databricksTable.table
string
required

Databricks table or view

​
ids.trinoTable.host
string
required

Hostname of the Trino instance

​
ids.trinoTable.catalog
string
required

Trino catalog

​
ids.trinoTable.schema
string
required

Trino schema

​
ids.trinoTable.table
string
required

Trino table or view

​
ids.sqlMeshModel.integrationId
string<uuid>
required

SYNQ integration_id that identifies the dbt Core project

​
ids.sqlMeshModel.fqn
string
required

SQLMesh model fully qualified name

​
ids.sqlMeshAudit.integrationId
string<uuid>
required

SYNQ integration_id that identifies the dbt Core project

​
ids.sqlMeshAudit.fqn
string
required

SQLMesh model fully qualified name

​
ids.sqlMeshAudit.auditId
string
required

Identifier of the audit

​
ids.monitor.monitorId
string
required

Identifier of the monitor

​
ids.monitor.segment
string

Optional monitor segmentation identifier

​
ids.monitor.integrationId
string
deprecated

SYNQ integration_id of the monitored identifier

Response

200
application/json

Success

BatchGetEntitiesResponse is the response message for the BatchGetEntities method.