SearchEntities
curl --request GET \
--url https://developer.synq.io/api/entities/v1/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://developer.synq.io/api/entities/v1/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://developer.synq.io/api/entities/v1/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://developer.synq.io/api/entities/v1/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://developer.synq.io/api/entities/v1/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://developer.synq.io/api/entities/v1/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/v1/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}
]
}synq.entities.entities.v1.EntitiesService
SearchEntities
Search for entities.
GET
/
api
/
entities
/
v1
/
search
SearchEntities
curl --request GET \
--url https://developer.synq.io/api/entities/v1/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://developer.synq.io/api/entities/v1/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://developer.synq.io/api/entities/v1/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://developer.synq.io/api/entities/v1/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://developer.synq.io/api/entities/v1/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://developer.synq.io/api/entities/v1/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/v1/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Full text search query, it will search in name but also in description and columns of the entities
Minimum string length:
1Limit 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_SEMANTIC_MODEL, 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_SNOWFLAKE_EXTERNAL_TABLE, ENTITY_TYPE_SNOWFLAKE_MATERIALIZED_VIEW, ENTITY_TYPE_SNOWFLAKE_PROCEDURE, ENTITY_TYPE_SNOWFLAKE_FUNCTION, ENTITY_TYPE_SNOWFLAKE_SEMANTIC_VIEW, ENTITY_TYPE_REDSHIFT_TABLE, ENTITY_TYPE_REDSHIFT_VIEW, ENTITY_TYPE_REDSHIFT_PROCEDURE, ENTITY_TYPE_REDSHIFT_FUNCTION, 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_RECON_SUITE, ENTITY_TYPE_RECON_CASE, 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_JOB_TASK, 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_COALESCE_PROJECT, ENTITY_TYPE_COALESCE_ENVIRONMENT, ENTITY_TYPE_COALESCE_NODE, ENTITY_TYPE_COALESCE_NODE_TEST, ENTITY_TYPE_COALESCE_JOB, ENTITY_TYPE_CASTORDOC_TABLE, ENTITY_TYPE_CASTORDOC_DASHBOARD, ENTITY_TYPE_CASTORDOC_VIEW, ENTITY_TYPE_CASTORDOC_TILE, ENTITY_TYPE_CASTORDOC_VIZ_MODEL, ENTITY_TYPE_POWERBI_REPORT, ENTITY_TYPE_POWERBI_TILE, ENTITY_TYPE_POWERBI_DATASET, ENTITY_TYPE_POWERBI_DASHBOARD, ENTITY_TYPE_POWERBI_TENANT, ENTITY_TYPE_THOUGHTSPOT_LIVEBOARD, ENTITY_TYPE_THOUGHTSPOT_WORKSHEET, ENTITY_TYPE_SIGMA_WORKBOOK, ENTITY_TYPE_SIGMA_DATA_MODEL, ENTITY_TYPE_SIGMA_ORGANIZATION, ENTITY_TYPE_DOMO_PAGE, ENTITY_TYPE_DOMO_DATASET, ENTITY_TYPE_MSSQL_TABLE, ENTITY_TYPE_MSSQL_VIEW, ENTITY_TYPE_ORACLE_TABLE, ENTITY_TYPE_ORACLE_VIEW, ENTITY_TYPE_ATHENA_TABLE, ENTITY_TYPE_ATHENA_VIEW, ENTITY_TYPE_FABRIC_TABLE, ENTITY_TYPE_FABRIC_VIEW, ENTITY_TYPE_CUSTOM_ENTITY_GENERIC, ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MIN, ENTITY_TYPE_CUSTOM_ENTITY_CUSTOM_TYPE_MAX Response
200 - application/json
Success