curl --request POST \
--url https://developer.synq.io/api/entities/activity/v1alpha/actor-summary \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"actor": {
"coalesce": "true"
},
"until": "2023-01-15T01:30:15.01Z",
"windowDays": 91,
"timeZone": "<string>",
"topK": 123
}
'import requests
url = "https://developer.synq.io/api/entities/activity/v1alpha/actor-summary"
payload = {
"actor": { "coalesce": "true" },
"until": "2023-01-15T01:30:15.01Z",
"windowDays": 91,
"timeZone": "<string>",
"topK": 123
}
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({
actor: {coalesce: 'true'},
until: '2023-01-15T01:30:15.01Z',
windowDays: 91,
timeZone: '<string>',
topK: 123
})
};
fetch('https://developer.synq.io/api/entities/activity/v1alpha/actor-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/entities/activity/v1alpha/actor-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([
'actor' => [
'coalesce' => 'true'
],
'until' => '2023-01-15T01:30:15.01Z',
'windowDays' => 91,
'timeZone' => '<string>',
'topK' => 123
]),
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/actor-summary"
payload := strings.NewReader("{\n \"actor\": {\n \"coalesce\": \"true\"\n },\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"timeZone\": \"<string>\",\n \"topK\": 123\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/actor-summary")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"actor\": {\n \"coalesce\": \"true\"\n },\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"timeZone\": \"<string>\",\n \"topK\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/activity/v1alpha/actor-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 \"actor\": {\n \"coalesce\": \"true\"\n },\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"timeZone\": \"<string>\",\n \"topK\": 123\n}"
response = http.request(request)
puts response.read_body{
"from": "2023-01-15T01:30:15.01Z",
"to": "2023-01-15T01:30:15.01Z",
"timeZone": "<string>",
"platformUserIds": [
"<string>"
],
"totals": {
"queries": 123,
"weights": [
{
"platform": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"computeUnit": "COMPUTE_UNIT_UNSPECIFIED",
"weights": {
"executionMs": "<unknown>",
"computeMs": "<unknown>",
"bytesScanned": "<unknown>",
"bytesBilled": "<unknown>"
}
}
],
"reads": 123,
"inputs": 123,
"writes": 123,
"runs": 123,
"entitiesRead": 123,
"entitiesWritten": 123,
"activeDays": 123,
"outsideEntities": {
"executionMs": 123,
"computeMs": 123,
"bytesScanned": 123,
"bytesBilled": 123
}
},
"computes": [
{
"platformRootId": "<string>",
"computeId": "<string>",
"platform": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"computeUnit": "COMPUTE_UNIT_UNSPECIFIED",
"queries": 123,
"weights": {
"executionMs": "<unknown>",
"computeMs": "<unknown>",
"bytesScanned": "<unknown>",
"bytesBilled": "<unknown>"
}
}
],
"entities": [
{
"entityId": "<string>",
"direction": "ACTIVITY_DIRECTION_UNSPECIFIED",
"measure": "ACTIVITY_MEASURE_UNSPECIFIED",
"count": 123,
"shares": {
"executionMs": 123,
"computeMs": 123,
"bytesScanned": 123,
"bytesBilled": 123
},
"lastSeenAt": "2023-01-15T01:30:15.01Z",
"activeDays": 123
}
],
"hourly": [
{
"start": "2023-01-15T01:30:15.01Z",
"count": 123,
"byIssuer": [
{
"issuer": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"count": 123
}
],
"covered": true,
"coveredHours": 123,
"partial": true
}
],
"daily": [
{
"start": "2023-01-15T01:30:15.01Z",
"count": 123,
"byIssuer": [
{
"issuer": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"count": 123
}
],
"covered": true,
"coveredHours": 123,
"partial": true
}
],
"grid": {
"days": [
{
"isoWeekday": 123,
"hours": [
123
],
"occurrences": 123
}
]
}
}GetActorSummary
Read what one actor read, built and wrote over the window, what its queries cost per compute and platform, and when it works. The actor is asked for by name, so nothing is left out for being Coalesce Quality’s own access, a writer’s own read or a policy. Without the platform users scope only an issuer entity, a job or step, may be asked for, and the answer names no login.
curl --request POST \
--url https://developer.synq.io/api/entities/activity/v1alpha/actor-summary \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"actor": {
"coalesce": "true"
},
"until": "2023-01-15T01:30:15.01Z",
"windowDays": 91,
"timeZone": "<string>",
"topK": 123
}
'import requests
url = "https://developer.synq.io/api/entities/activity/v1alpha/actor-summary"
payload = {
"actor": { "coalesce": "true" },
"until": "2023-01-15T01:30:15.01Z",
"windowDays": 91,
"timeZone": "<string>",
"topK": 123
}
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({
actor: {coalesce: 'true'},
until: '2023-01-15T01:30:15.01Z',
windowDays: 91,
timeZone: '<string>',
topK: 123
})
};
fetch('https://developer.synq.io/api/entities/activity/v1alpha/actor-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/entities/activity/v1alpha/actor-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([
'actor' => [
'coalesce' => 'true'
],
'until' => '2023-01-15T01:30:15.01Z',
'windowDays' => 91,
'timeZone' => '<string>',
'topK' => 123
]),
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/actor-summary"
payload := strings.NewReader("{\n \"actor\": {\n \"coalesce\": \"true\"\n },\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"timeZone\": \"<string>\",\n \"topK\": 123\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/actor-summary")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"actor\": {\n \"coalesce\": \"true\"\n },\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"timeZone\": \"<string>\",\n \"topK\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/activity/v1alpha/actor-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 \"actor\": {\n \"coalesce\": \"true\"\n },\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"timeZone\": \"<string>\",\n \"topK\": 123\n}"
response = http.request(request)
puts response.read_body{
"from": "2023-01-15T01:30:15.01Z",
"to": "2023-01-15T01:30:15.01Z",
"timeZone": "<string>",
"platformUserIds": [
"<string>"
],
"totals": {
"queries": 123,
"weights": [
{
"platform": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"computeUnit": "COMPUTE_UNIT_UNSPECIFIED",
"weights": {
"executionMs": "<unknown>",
"computeMs": "<unknown>",
"bytesScanned": "<unknown>",
"bytesBilled": "<unknown>"
}
}
],
"reads": 123,
"inputs": 123,
"writes": 123,
"runs": 123,
"entitiesRead": 123,
"entitiesWritten": 123,
"activeDays": 123,
"outsideEntities": {
"executionMs": 123,
"computeMs": 123,
"bytesScanned": 123,
"bytesBilled": 123
}
},
"computes": [
{
"platformRootId": "<string>",
"computeId": "<string>",
"platform": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"computeUnit": "COMPUTE_UNIT_UNSPECIFIED",
"queries": 123,
"weights": {
"executionMs": "<unknown>",
"computeMs": "<unknown>",
"bytesScanned": "<unknown>",
"bytesBilled": "<unknown>"
}
}
],
"entities": [
{
"entityId": "<string>",
"direction": "ACTIVITY_DIRECTION_UNSPECIFIED",
"measure": "ACTIVITY_MEASURE_UNSPECIFIED",
"count": 123,
"shares": {
"executionMs": 123,
"computeMs": 123,
"bytesScanned": 123,
"bytesBilled": 123
},
"lastSeenAt": "2023-01-15T01:30:15.01Z",
"activeDays": 123
}
],
"hourly": [
{
"start": "2023-01-15T01:30:15.01Z",
"count": 123,
"byIssuer": [
{
"issuer": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"count": 123
}
],
"covered": true,
"coveredHours": 123,
"partial": true
}
],
"daily": [
{
"start": "2023-01-15T01:30:15.01Z",
"count": 123,
"byIssuer": [
{
"issuer": "DATA_PLATFORM_TYPE_UNSPECIFIED",
"count": 123
}
],
"covered": true,
"coveredHours": 123,
"partial": true
}
],
"grid": {
"days": [
{
"isoWeekday": 123,
"hours": [
123
],
"occurrences": 123
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
ActorRef names who an actor summary is about.
- coalesce
- group
- issuer
- issuer_entity_id
- person_identity
- platform_user_id
- service_account_id
Show child attributes
Show child attributes
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 <= 92The IANA time zone days and grid cells are in. Unset is UTC.
64At most this many entities per direction. Unset is 20.
x <= 1000Response
Success
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"
The time zone used, "UTC" when none was asked.
The logins the actor resolved to, sorted. Empty without the platform users scope.
ActorTotals is an actor's whole window.
Show child attributes
Show child attributes
Ordered by platform instance, then compute.
Show child attributes
Show child attributes
At most top_k per direction, READ, INPUT, then WRITE, each by count. For a job, a WRITE row of measure RUNS counts the runs of what it builds, never write queries.
Show child attributes
Show child attributes
The actor's queries per UTC hour, split by issuer.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
WeekGrid is when access happens in the week: seven days, Monday first.
Show child attributes
Show child attributes