Skip to main content
GET
/
api
/
entities
/
v1
/
search
SearchEntities
curl --request GET \
  --url https://developer.synq.io/api/entities/v1/search \
  --header 'Authorization: Bearer <token>'
{
  "hits": [
    {
      "name": "<string>",
      "description": "<string>",
      "entityId": {
        "airflowDag": {
          "integrationId": "<string>",
          "dagId": "<string>"
        }
      },
      "synqPath": "<string>",
      "entityType": "ENTITY_TYPE_UNSPECIFIED",
      "rankingScore": 123
    }
  ],
  "estimatedTotalHits": 123,
  "entityTypeEstimates": [
    {
      "entityType": "ENTITY_TYPE_UNSPECIFIED",
      "count": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
query
string
required

Full text search query, it will search in name but also in description and columns of the entities

Minimum string length: 1
​
limitToTypes
enum<string>[]

Limit results to specific entity types, leave empty to use only the query

Available options:
ENTITY_TYPE_UNSPECIFIED,
ENTITY_TYPE_BQ_TABLE,
ENTITY_TYPE_BQ_VIEW,
ENTITY_TYPE_LOOKER_LOOK,
ENTITY_TYPE_LOOKER_EXPLORE,
ENTITY_TYPE_LOOKER_VIEW,
ENTITY_TYPE_LOOKER_DASHBOARD,
ENTITY_TYPE_DBT_MODEL,
ENTITY_TYPE_DBT_TEST,
ENTITY_TYPE_DBT_SOURCE,
ENTITY_TYPE_DBT_PROJECT,
ENTITY_TYPE_DBT_METRIC,
ENTITY_TYPE_DBT_SNAPSHOT,
ENTITY_TYPE_DBT_SEED,
ENTITY_TYPE_DBT_ANALYSIS,
ENTITY_TYPE_DBT_EXPOSURE,
ENTITY_TYPE_DBT_GROUP,
ENTITY_TYPE_DBT_CLOUD_PROJECT,
ENTITY_TYPE_DBT_CLOUD_JOB,
ENTITY_TYPE_SNOWFLAKE_TABLE,
ENTITY_TYPE_SNOWFLAKE_VIEW,
ENTITY_TYPE_SNOWFLAKE_STREAM,
ENTITY_TYPE_SNOWFLAKE_DYNAMIC_TABLE,
ENTITY_TYPE_SNOWFLAKE_TASK,
ENTITY_TYPE_REDSHIFT_TABLE,
ENTITY_TYPE_REDSHIFT_VIEW,
ENTITY_TYPE_TABLEAU_EMBEDDED,
ENTITY_TYPE_TABLEAU_PUBLISHED,
ENTITY_TYPE_TABLEAU_CUSTOM_SQL,
ENTITY_TYPE_TABLEAU_TABLE,
ENTITY_TYPE_TABLEAU_SHEET,
ENTITY_TYPE_TABLEAU_DASHBOARD,
ENTITY_TYPE_AIRFLOW_DAG,
ENTITY_TYPE_AIRFLOW_TASK,
ENTITY_TYPE_CLICKHOUSE_TABLE,
ENTITY_TYPE_CLICKHOUSE_VIEW,
ENTITY_TYPE_ANOMALY_MONITOR,
ENTITY_TYPE_ANOMALY_MONITOR_SEGMENT,
ENTITY_TYPE_SQLTEST_TEST,
ENTITY_TYPE_POSTGRES_TABLE,
ENTITY_TYPE_POSTGRES_VIEW,
ENTITY_TYPE_MYSQL_TABLE,
ENTITY_TYPE_MYSQL_VIEW,
ENTITY_TYPE_DATABRICKS_WAREHOUSE,
ENTITY_TYPE_DATABRICKS_TABLE,
ENTITY_TYPE_DATABRICKS_VIEW,
ENTITY_TYPE_DATABRICKS_JOB,
ENTITY_TYPE_DATABRICKS_NOTEBOOK,
ENTITY_TYPE_DATABRICKS_QUERY,
ENTITY_TYPE_DATABRICKS_DASHBOARD,
ENTITY_TYPE_SQLMESH_PROJECT,
ENTITY_TYPE_SQLMESH_SQL_MODEL,
ENTITY_TYPE_SQLMESH_PYTHON_MODEL,
ENTITY_TYPE_SQLMESH_EXTERNAL,
ENTITY_TYPE_SQLMESH_SEED,
ENTITY_TYPE_SQLMESH_AUDIT,
ENTITY_TYPE_SQLMESH_UNIT_TEST,
ENTITY_TYPE_SQLMESH_ENVIRONMENT,
ENTITY_TYPE_SQLMESH_SNAPSHOT,
ENTITY_TYPE_DUCKDB_TABLE,
ENTITY_TYPE_DUCKDB_VIEW,
ENTITY_TYPE_TRINO_TABLE,
ENTITY_TYPE_TRINO_VIEW,
ENTITY_TYPE_ATLAN_ASSET,
ENTITY_TYPE_ATLAN_INTEGRATION,
ENTITY_TYPE_CASTORDOC_TABLE,
ENTITY_TYPE_CASTORDOC_DASHBOARD,
ENTITY_TYPE_CASTORDOC_VIEW,
ENTITY_TYPE_CUSTOM_ENTITY_GENERIC,
ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MIN,
ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MAX
​
page
integer
​
limitPerPage
integer

Response

200 - application/json

Success

​
hits
SearchHit · object[]

The entities that were retrieved.

​
estimatedTotalHits

Estimated number of all search results

​
entityTypeEstimates
EntityTypeSearchFacet · object[]

Estimated number of all search results by entity type