GetCoverageSummary
curl --request POST \
--url https://developer.synq.io/api/overlays/v1/coverage-summary \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"selections": [
{
"selection": {
"publicQuery": {
"parts": [
{
"entityIds": {
"entityIds": [
"<string>"
]
}
}
]
}
},
"key": "<string>"
}
]
}
'import requests
url = "https://developer.synq.io/api/overlays/v1/coverage-summary"
payload = { "selections": [
{
"selection": { "publicQuery": { "parts": [{ "entityIds": { "entityIds": ["<string>"] } }] } },
"key": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
selections: [
{
selection: {publicQuery: {parts: [{entityIds: {entityIds: ['<string>']}}]}},
key: '<string>'
}
]
})
};
fetch('https://developer.synq.io/api/overlays/v1/coverage-summary', 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/overlays/v1/coverage-summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'selections' => [
[
'selection' => [
'publicQuery' => [
'parts' => [
[
'entityIds' => [
'entityIds' => [
'<string>'
]
]
]
]
]
],
'key' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://developer.synq.io/api/overlays/v1/coverage-summary"
payload := strings.NewReader("{\n \"selections\": [\n {\n \"selection\": {\n \"publicQuery\": {\n \"parts\": [\n {\n \"entityIds\": {\n \"entityIds\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n },\n \"key\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://developer.synq.io/api/overlays/v1/coverage-summary")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"selections\": [\n {\n \"selection\": {\n \"publicQuery\": {\n \"parts\": [\n {\n \"entityIds\": {\n \"entityIds\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n },\n \"key\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/overlays/v1/coverage-summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"selections\": [\n {\n \"selection\": {\n \"publicQuery\": {\n \"parts\": [\n {\n \"entityIds\": {\n \"entityIds\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n },\n \"key\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"summaries": [
{
"key": "<string>",
"total": 123,
"withDataproduct": 123,
"withOwner": 123,
"withBoth": 123,
"withNeither": 123
}
],
"membersComputedAt": "2023-01-15T01:30:15.01Z"
}synq.overlays.v1.OverlaysService
GetCoverageSummary
Count coverage over one or more named candidate sets, without listing the assets themselves.
The aggregate behind a coverage dashboard. Each selection you send comes back as one row of totals, keyed by the label you gave it, so a breakdown by type, platform, folder or domain is one round trip rather than one call per bucket.
There is no server-side grouping, on purpose. This service knows what claims
an asset, not what kind of thing the asset is, so naming the selections
yourself — with_type("dbt_model"), in_folder(...), in_domain(...) —
keeps the buckets in your own vocabulary and costs the same.
Selections are counted independently and may overlap. An asset in two of them is counted in both.
Returns PERMISSION_DENIED unless your credential can read both data products and owners. Every row names both, and a zero that was never looked at is indistinguishable from a zero that was.
POST
/
api
/
overlays
/
v1
/
coverage-summary
GetCoverageSummary
curl --request POST \
--url https://developer.synq.io/api/overlays/v1/coverage-summary \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"selections": [
{
"selection": {
"publicQuery": {
"parts": [
{
"entityIds": {
"entityIds": [
"<string>"
]
}
}
]
}
},
"key": "<string>"
}
]
}
'import requests
url = "https://developer.synq.io/api/overlays/v1/coverage-summary"
payload = { "selections": [
{
"selection": { "publicQuery": { "parts": [{ "entityIds": { "entityIds": ["<string>"] } }] } },
"key": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
selections: [
{
selection: {publicQuery: {parts: [{entityIds: {entityIds: ['<string>']}}]}},
key: '<string>'
}
]
})
};
fetch('https://developer.synq.io/api/overlays/v1/coverage-summary', 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/overlays/v1/coverage-summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'selections' => [
[
'selection' => [
'publicQuery' => [
'parts' => [
[
'entityIds' => [
'entityIds' => [
'<string>'
]
]
]
]
]
],
'key' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://developer.synq.io/api/overlays/v1/coverage-summary"
payload := strings.NewReader("{\n \"selections\": [\n {\n \"selection\": {\n \"publicQuery\": {\n \"parts\": [\n {\n \"entityIds\": {\n \"entityIds\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n },\n \"key\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://developer.synq.io/api/overlays/v1/coverage-summary")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"selections\": [\n {\n \"selection\": {\n \"publicQuery\": {\n \"parts\": [\n {\n \"entityIds\": {\n \"entityIds\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n },\n \"key\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/overlays/v1/coverage-summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"selections\": [\n {\n \"selection\": {\n \"publicQuery\": {\n \"parts\": [\n {\n \"entityIds\": {\n \"entityIds\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n },\n \"key\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"summaries": [
{
"key": "<string>",
"total": 123,
"withDataproduct": 123,
"withOwner": 123,
"withBoth": 123,
"withNeither": 123
}
],
"membersComputedAt": "2023-01-15T01:30:15.01Z"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The candidate sets to count: 1 to 20, with distinct keys.
Required array length:
1 - 20 elementsShow child attributes
Show child attributes
Where the answer is computed from. Defaults to the recomputed membership.
FRESHNESS_LIVE re-resolves every definition once for the whole request,
not once per selection, so several selections cost little more than one.
Available options:
FRESHNESS_UNSPECIFIED, FRESHNESS_CACHED, FRESHNESS_LIVE Response
200 - application/json
Success
One entry per requested selection, in the order they were requested.
Show child attributes
Show child attributes
When the recomputation behind these totals last ran to completion — the start of the most recent successful pass over the workspace's overlays.
Absent under FRESHNESS_LIVE, and absent when the workspace has no overlay
of a readable kind, or none has been computed yet.
Examples:
"2023-01-15T01:30:15.01Z"
"2024-12-25T12:00:00Z"