curl --request POST \
--url https://developer.synq.io/api/entities/activity/v1alpha/signals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"until": "2023-01-15T01:30:15.01Z",
"windowDays": 91,
"selection": {
"publicQuery": {
"parts": [
{
"entityIds": {
"entityIds": [
"<string>"
]
}
}
]
}
},
"pagination": {
"cursor": "<string>",
"pageSize": 1
}
}
'import requests
url = "https://developer.synq.io/api/entities/activity/v1alpha/signals"
payload = {
"until": "2023-01-15T01:30:15.01Z",
"windowDays": 91,
"selection": { "publicQuery": { "parts": [{ "entityIds": { "entityIds": ["<string>"] } }] } },
"pagination": {
"cursor": "<string>",
"pageSize": 1
}
}
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({
until: '2023-01-15T01:30:15.01Z',
windowDays: 91,
selection: {publicQuery: {parts: [{entityIds: {entityIds: ['<string>']}}]}},
pagination: {cursor: '<string>', pageSize: 1}
})
};
fetch('https://developer.synq.io/api/entities/activity/v1alpha/signals', 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/activity/v1alpha/signals",
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([
'until' => '2023-01-15T01:30:15.01Z',
'windowDays' => 91,
'selection' => [
'publicQuery' => [
'parts' => [
[
'entityIds' => [
'entityIds' => [
'<string>'
]
]
]
]
]
],
'pagination' => [
'cursor' => '<string>',
'pageSize' => 1
]
]),
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/entities/activity/v1alpha/signals"
payload := strings.NewReader("{\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"selection\": {\n \"publicQuery\": {\n \"parts\": [\n {\n \"entityIds\": {\n \"entityIds\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n },\n \"pagination\": {\n \"cursor\": \"<string>\",\n \"pageSize\": 1\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/entities/activity/v1alpha/signals")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"selection\": {\n \"publicQuery\": {\n \"parts\": [\n {\n \"entityIds\": {\n \"entityIds\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n },\n \"pagination\": {\n \"cursor\": \"<string>\",\n \"pageSize\": 1\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/activity/v1alpha/signals")
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 \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"selection\": {\n \"publicQuery\": {\n \"parts\": [\n {\n \"entityIds\": {\n \"entityIds\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n },\n \"pagination\": {\n \"cursor\": \"<string>\",\n \"pageSize\": 1\n }\n}"
response = http.request(request)
puts response.read_body{
"signal": "ACCESS_SIGNAL_UNSPECIFIED",
"entities": [
{
"entityId": "<string>",
"writes": 123,
"buildShares": [
{
"platform": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"computeUnit": "COMPUTE_UNIT_UNSPECIFIED",
"shares": {
"executionMs": 123,
"computeMs": 123,
"bytesScanned": 123,
"bytesBilled": 123
}
}
],
"lastWrittenAt": "2023-01-15T01:30:15.01Z",
"schema": {
"instance": "<string>",
"database": "<string>",
"schema": "<string>"
},
"reads": 123,
"sharedReads": 123,
"outsideWrites": 123,
"writingLogins": 123
}
],
"total": 123,
"from": "2023-01-15T01:30:15.01Z",
"to": "2023-01-15T01:30:15.01Z",
"pageInfo": {
"totalCount": 123,
"count": 123,
"lastId": "<string>"
},
"schemas": [
{
"schema": {
"instance": "<string>",
"database": "<string>",
"schema": "<string>"
},
"entities": 123
}
],
"tools": [
{
"issuer": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"reads": 123,
"sharedReads": 123,
"share": 123
}
]
}ListAccessSignals
List the entities of the workspace, or of a selection, that one signal names, such as the tables a pipeline builds and nobody reads, or the tables nobody touched. A signal is computed from the window’s access on each call, so a service account change shows on the next one. It names entities and tools, never a login.
curl --request POST \
--url https://developer.synq.io/api/entities/activity/v1alpha/signals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"until": "2023-01-15T01:30:15.01Z",
"windowDays": 91,
"selection": {
"publicQuery": {
"parts": [
{
"entityIds": {
"entityIds": [
"<string>"
]
}
}
]
}
},
"pagination": {
"cursor": "<string>",
"pageSize": 1
}
}
'import requests
url = "https://developer.synq.io/api/entities/activity/v1alpha/signals"
payload = {
"until": "2023-01-15T01:30:15.01Z",
"windowDays": 91,
"selection": { "publicQuery": { "parts": [{ "entityIds": { "entityIds": ["<string>"] } }] } },
"pagination": {
"cursor": "<string>",
"pageSize": 1
}
}
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({
until: '2023-01-15T01:30:15.01Z',
windowDays: 91,
selection: {publicQuery: {parts: [{entityIds: {entityIds: ['<string>']}}]}},
pagination: {cursor: '<string>', pageSize: 1}
})
};
fetch('https://developer.synq.io/api/entities/activity/v1alpha/signals', 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/activity/v1alpha/signals",
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([
'until' => '2023-01-15T01:30:15.01Z',
'windowDays' => 91,
'selection' => [
'publicQuery' => [
'parts' => [
[
'entityIds' => [
'entityIds' => [
'<string>'
]
]
]
]
]
],
'pagination' => [
'cursor' => '<string>',
'pageSize' => 1
]
]),
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/entities/activity/v1alpha/signals"
payload := strings.NewReader("{\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"selection\": {\n \"publicQuery\": {\n \"parts\": [\n {\n \"entityIds\": {\n \"entityIds\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n },\n \"pagination\": {\n \"cursor\": \"<string>\",\n \"pageSize\": 1\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/entities/activity/v1alpha/signals")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"selection\": {\n \"publicQuery\": {\n \"parts\": [\n {\n \"entityIds\": {\n \"entityIds\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n },\n \"pagination\": {\n \"cursor\": \"<string>\",\n \"pageSize\": 1\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/activity/v1alpha/signals")
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 \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"selection\": {\n \"publicQuery\": {\n \"parts\": [\n {\n \"entityIds\": {\n \"entityIds\": [\n \"<string>\"\n ]\n }\n }\n ]\n }\n },\n \"pagination\": {\n \"cursor\": \"<string>\",\n \"pageSize\": 1\n }\n}"
response = http.request(request)
puts response.read_body{
"signal": "ACCESS_SIGNAL_UNSPECIFIED",
"entities": [
{
"entityId": "<string>",
"writes": 123,
"buildShares": [
{
"platform": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"computeUnit": "COMPUTE_UNIT_UNSPECIFIED",
"shares": {
"executionMs": 123,
"computeMs": 123,
"bytesScanned": 123,
"bytesBilled": 123
}
}
],
"lastWrittenAt": "2023-01-15T01:30:15.01Z",
"schema": {
"instance": "<string>",
"database": "<string>",
"schema": "<string>"
},
"reads": 123,
"sharedReads": 123,
"outsideWrites": 123,
"writingLogins": 123
}
],
"total": 123,
"from": "2023-01-15T01:30:15.01Z",
"to": "2023-01-15T01:30:15.01Z",
"pageInfo": {
"totalCount": 123,
"count": 123,
"lastId": "<string>"
},
"schemas": [
{
"schema": {
"instance": "<string>",
"database": "<string>",
"schema": "<string>"
},
"entities": 123
}
],
"tools": [
{
"issuer": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"reads": 123,
"sharedReads": 123,
"share": 123
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The window ends at the start of this hour, exclusive. Unset is the current hour.
"2023-01-15T01:30:15.01Z"
"2024-12-25T12:00:00Z"
The window's length in days, back from until. Unset is 30.
x <= 92Only these entities, such as a data product's. Unset is the whole workspace. A selection of more than 50,000 entities, counting the entities each is the same as, is refused with INVALID_ARGUMENT.
- public_query
- resolver_ql
Show child attributes
Show child attributes
AccessSignal is a place where how an entity is used and what is expected of it disagree. Coalesce Quality's own access, such as a monitor reading a table, never counts as using it.
ACCESS_SIGNAL_UNSPECIFIED, ACCESS_SIGNAL_BUILT_NEVER_READ, ACCESS_SIGNAL_UNTOUCHED, ACCESS_SIGNAL_READ_WITHOUT_VIEWER, ACCESS_SIGNAL_WRITTEN_OUTSIDE_PIPELINE Without a page size every entity is returned.
Show child attributes
Show child attributes
Response
Success
AccessSignal is a place where how an entity is used and what is expected of it disagree. Coalesce Quality's own access, such as a monitor reading a table, never counts as using it.
ACCESS_SIGNAL_UNSPECIFIED, ACCESS_SIGNAL_BUILT_NEVER_READ, ACCESS_SIGNAL_UNTOUCHED, ACCESS_SIGNAL_READ_WITHOUT_VIEWER, ACCESS_SIGNAL_WRITTEN_OUTSIDE_PIPELINE One page of the entities that raise the signal. BUILT_NEVER_READ by build compute, highest first, READ_WITHOUT_VIEWER by shared reads and WRITTEN_OUTSIDE_PIPELINE by outside writes, each then by entity id. UNTOUCHED by schema, then entity id, those with no known schema last.
Show child attributes
Show child attributes
How many entities raise the signal, on every page.
A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.
All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a 24-hour linear smear.
The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.
Examples
Example 1: Compute Timestamp from POSIX time().
Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);
Example 2: Compute Timestamp from POSIX gettimeofday().
struct timeval tv;
gettimeofday(&tv, NULL);
Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);
Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().
FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
Example 4: Compute Timestamp from Java System.currentTimeMillis().
long millis = System.currentTimeMillis();
Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();
Example 5: Compute Timestamp from Java Instant.now().
Instant now = Instant.now();
Timestamp timestamp =
Timestamp.newBuilder().setSeconds(now.getEpochSecond())
.setNanos(now.getNano()).build();
Example 6: Compute Timestamp from current time in Python.
timestamp = Timestamp()
timestamp.GetCurrentTime()
JSON Mapping
In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).
For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017.
In JavaScript, one can convert a Date object to this format using the
standard
toISOString()
method. In Python, a standard datetime.datetime object can be converted
to this format using
strftime with
the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.
"2023-01-15T01:30:15.01Z"
"2024-12-25T12:00:00Z"
A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.
All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a 24-hour linear smear.
The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from RFC 3339 date strings.
Examples
Example 1: Compute Timestamp from POSIX time().
Timestamp timestamp;
timestamp.set_seconds(time(NULL));
timestamp.set_nanos(0);
Example 2: Compute Timestamp from POSIX gettimeofday().
struct timeval tv;
gettimeofday(&tv, NULL);
Timestamp timestamp;
timestamp.set_seconds(tv.tv_sec);
timestamp.set_nanos(tv.tv_usec * 1000);
Example 3: Compute Timestamp from Win32 GetSystemTimeAsFileTime().
FILETIME ft;
GetSystemTimeAsFileTime(&ft);
UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
// A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
// is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
Timestamp timestamp;
timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
Example 4: Compute Timestamp from Java System.currentTimeMillis().
long millis = System.currentTimeMillis();
Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
.setNanos((int) ((millis % 1000) * 1000000)).build();
Example 5: Compute Timestamp from Java Instant.now().
Instant now = Instant.now();
Timestamp timestamp =
Timestamp.newBuilder().setSeconds(now.getEpochSecond())
.setNanos(now.getNano()).build();
Example 6: Compute Timestamp from current time in Python.
timestamp = Timestamp()
timestamp.GetCurrentTime()
JSON Mapping
In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset).
For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017.
In JavaScript, one can convert a Date object to this format using the
standard
toISOString()
method. In Python, a standard datetime.datetime object can be converted
to this format using
strftime with
the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
the Joda Time's ISODateTimeFormat.dateTime() to obtain a formatter capable of generating timestamps in this format.
"2023-01-15T01:30:15.01Z"
"2024-12-25T12:00:00Z"
Show child attributes
Show child attributes
UNTOUCHED: every schema with untouched tables and views, by how many, highest first.
Show child attributes
Show child attributes
READ_WITHOUT_VIEWER: the counted reads of every entity per tool, and those of them through a shared login, by shared reads, highest first.
Show child attributes
Show child attributes