curl --request POST \
--url https://developer.synq.io/api/entities/activity/v1alpha/series \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entityId": "<string>",
"until": "2023-01-15T01:30:15.01Z",
"windowDays": 91,
"timeZone": "<string>"
}
'import requests
url = "https://developer.synq.io/api/entities/activity/v1alpha/series"
payload = {
"entityId": "<string>",
"until": "2023-01-15T01:30:15.01Z",
"windowDays": 91,
"timeZone": "<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({
entityId: '<string>',
until: '2023-01-15T01:30:15.01Z',
windowDays: 91,
timeZone: '<string>'
})
};
fetch('https://developer.synq.io/api/entities/activity/v1alpha/series', 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/series",
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([
'entityId' => '<string>',
'until' => '2023-01-15T01:30:15.01Z',
'windowDays' => 91,
'timeZone' => '<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/entities/activity/v1alpha/series"
payload := strings.NewReader("{\n \"entityId\": \"<string>\",\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"timeZone\": \"<string>\"\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/series")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entityId\": \"<string>\",\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"timeZone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/activity/v1alpha/series")
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 \"entityId\": \"<string>\",\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"timeZone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"entityId": "<string>",
"from": "2023-01-15T01:30:15.01Z",
"to": "2023-01-15T01:30:15.01Z",
"timeZone": "<string>",
"directions": [
{
"direction": "ACTIVITY_DIRECTION_UNSPECIFIED",
"measure": "ACTIVITY_MEASURE_UNSPECIFIED",
"total": 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
}
]
}
}
],
"notCounted": {
"coalesceLogins": 123,
"writersOwnReads": 123,
"intermediate": 123,
"coalesceQualityQueries": 123,
"excludedByPolicy": 123,
"excludedByLens": 123
}
}GetEntityActivitySeries
Read how access to one entity moves over the window: per direction, a point per UTC hour, a point per day in the asked time zone, and a weekday and hour grid. A direction’s total is the sum of its actors in ListEntityActors under the same lens. It names tools, never a login.
curl --request POST \
--url https://developer.synq.io/api/entities/activity/v1alpha/series \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entityId": "<string>",
"until": "2023-01-15T01:30:15.01Z",
"windowDays": 91,
"timeZone": "<string>"
}
'import requests
url = "https://developer.synq.io/api/entities/activity/v1alpha/series"
payload = {
"entityId": "<string>",
"until": "2023-01-15T01:30:15.01Z",
"windowDays": 91,
"timeZone": "<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({
entityId: '<string>',
until: '2023-01-15T01:30:15.01Z',
windowDays: 91,
timeZone: '<string>'
})
};
fetch('https://developer.synq.io/api/entities/activity/v1alpha/series', 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/series",
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([
'entityId' => '<string>',
'until' => '2023-01-15T01:30:15.01Z',
'windowDays' => 91,
'timeZone' => '<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/entities/activity/v1alpha/series"
payload := strings.NewReader("{\n \"entityId\": \"<string>\",\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"timeZone\": \"<string>\"\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/series")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entityId\": \"<string>\",\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"timeZone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/entities/activity/v1alpha/series")
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 \"entityId\": \"<string>\",\n \"until\": \"2023-01-15T01:30:15.01Z\",\n \"windowDays\": 91,\n \"timeZone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"entityId": "<string>",
"from": "2023-01-15T01:30:15.01Z",
"to": "2023-01-15T01:30:15.01Z",
"timeZone": "<string>",
"directions": [
{
"direction": "ACTIVITY_DIRECTION_UNSPECIFIED",
"measure": "ACTIVITY_MEASURE_UNSPECIFIED",
"total": 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
}
]
}
}
],
"notCounted": {
"coalesceLogins": 123,
"writersOwnReads": 123,
"intermediate": 123,
"coalesceQualityQueries": 123,
"excludedByPolicy": 123,
"excludedByLens": 123
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
1 - 2048The 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. 28 gives every weekday four times.
x <= 92ActivityLens picks which directions and which logins count. Coalesce Quality's own queries, a read of an intermediate table and a login's reads of a table it wrote the same day are left out under every lens, and writes never depend on it.
ACTIVITY_LENS_UNSPECIFIED, ACTIVITY_LENS_CONSUMPTION, ACTIVITY_LENS_DEVELOPMENT, ACTIVITY_LENS_MONITORING Unset is QUERIES.
ACTIVITY_MEASURE_UNSPECIFIED, ACTIVITY_MEASURE_QUERIES, ACTIVITY_MEASURE_VIEWS, ACTIVITY_MEASURE_RUNS The IANA time zone days and grid cells are in, such as "Europe/Warsaw". Unset is UTC. The window itself stays in whole UTC hours.
64SeriesSplit is how each point of a series is broken down.
SERIES_SPLIT_UNSPECIFIED, SERIES_SPLIT_ISSUER Response
Success
The window read, [from, to).
"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 lens's directions, then WRITE, each only when it has counted access.
Show child attributes
Show child attributes
NotCountedActivity is access a read saw and left out.
Show child attributes
Show child attributes